Each Pulse environment has its own API base URL.
The base URL is assigned when the environment is provisioned. Use the URL assigned to the environment rather than hard-coding an example hostname. It may follow a pattern similar to:
https://<environment>.tompitapp.net
Important
The exact hostname can differ. Use the base URL assigned to your Pulse environment.
All Pulse service paths are relative to the environment's base URL.
For example, the Food & Beverage Site resource uses the following path:
https://<environment-base-url>/manufacturing/food-beverage/v1/sites
Other domain models may expose different resource paths.
Authentication and authorization
Pulse Portal provides access to subscriptions and Pulse environments.
API access to an environment uses an authentication token associated with that environment. Pulse handles the internal authentication flow between its services; API clients and integrations only need to supply the required token.
Authentication token
Authenticated API requests use a Bearer token.
Generate an API token from the Pulse environment settings and copy it to the integration configuration.
Include the token in the Authorization header with every request:
Authorization: Bearer <your-token>
Do not place the token in the request URL.
Store the token securely
Treat the token as a secret.
- Store it in a secret manager or protected environment variable.
- Do not commit it to source control.
- Do not include it in application logs.
- Do not expose it in client-side code.
- Do not share it through email, chat, or documentation.
Configuration example
Keep the base URL and token outside the application code.
PULSE_BASE_URL=https://<organization-base-url>
PULSE_TOKEN=<your-token>
The application can then build service URLs from the configured base URL.
Next steps
- Choose a domain model.
- Follow the integration guide for the selected model.