Gozem Developer DocsDocs

This page covers the two environments the platform runs in, and how to get set up with an API client and credentials in the Partner Portal.

Environments

The platform runs two environments: sandbox for development and testing, and production for live operations. They are fully isolated. Each has its own base URL, its own API clients and credentials, and its own data. Nothing created in one environment works in the other.

Note: Build and validate everything in sandbox first, then move the same integration to production by changing your base URL and credentials.

Base URLs

Environment Base URL
Sandbox https://sandbox-api.gozem.co
Production https://api.gozem.co

Both environments share the same URL structure. Each service is reached under the base host through its own path prefix, followed by a version segment. The exact prefix and endpoints are documented in each service’s own section.

Sandbox

Sandbox is for development and testing. API behavior mirrors production as closely as possible, no real-world operations are carried out, and no charges occur. Sandbox data may be reset periodically, and rate limits follow the same general rules as production.

Some services behave differently in sandbox because parts of their real-world flow cannot be reproduced there. Where that applies, the service’s own section explains the difference and how to test the full flow in sandbox.

Production

Production serves live integrations. Requests affect real operations and real charges.

Caution: Only move to production once your integration is validated in sandbox.

Switching between environments

Target one environment at a time, by configuration. Your base URL, your client credentials, and your API client must all belong to the same environment.

The Partner Portal

The Partner Portal is where you manage your integration: API clients, credentials, environment access, and webhook endpoints. It is the entry point for every integration, and creating an API client there is how you get the client_id and client_secret you will use to authenticate.

In the portal you can:

  • Create and manage API clients (your applications)
  • Generate and rotate OAuth credentials (client ID and secret)
  • Select which services and endpoints a client may call
  • Configure webhook endpoints
  • View API usage and activity

One portal per environment

Sandbox and production have separate portal instances. Each has its own clients, credentials, configuration, and data, and the two are fully isolated. Credentials created in one environment do not work in the other. Access to each portal is granted independently as part of onboarding and go-live.

Changes you make in the portal, such as rotating a secret or updating access, take effect for new tokens immediately.

Creating your first API client

  1. Sign in to the Partner Portal. Go to the Partner Portal and sign in with your partner account.
  2. Open the API Clients section. Navigate to API Clients in the sidebar. This is where you create and manage application credentials.
  3. Create a new client. Click Create New Client and provide details about the integration you are building.
  4. Name the client. Use a clear, descriptive name so you can identify it later.
  5. Select the services and endpoints the client may call. Grant the client access to the services it needs and the specific endpoints within them. Grant only what the integration requires.
  6. Save and store your credentials. Click Save to generate your client_id and client_secret.

Warning: The secret is shown only once. Copy or download it and store it securely. It cannot be retrieved again after creation, and a lost secret means generating new credentials.

Access control

A client’s access is fixed when you create it. It is granted access to specific services and the specific endpoints within them, and that access is carried automatically by every token the client issues. You do not request access at token time.

A client can also be restricted to a set of source IP addresses. Both the endpoint access and the IP restriction are enforced on every request. See Authentication for how this plays out at call time.

Getting access

Partner Portal access is provisioned during onboarding. If you do not have access or need additional permissions, contact your Gozem representative.