Onboarding Process
API access is provisioned per integration using identity platform applications and scoped to specific Utopi operators and sites. You will receive unique credentials tied to your application, with access limited to only the operators and sites specified. Additional sites and permissions can be added later without changing your credentials.
Prerequisites
Before onboarding can begin, please ensure the following:
- Data access has been agreed with our Customer.
- You can provide a technical contact (name and email address) for API communications.
- You have the list of Utopi operators and sites required for your integration.
- You can share your public egress IP address(es) or CIDR ranges for IP allowlisting (Sandbox and Production). See: IP Allowlisting
Onboarding Steps
This section outlines the step-by-step onboarding journey, including what Utopi will provide and what we expect from you as a partner at each stage.
| Step | Utopi | Partner |
|---|---|---|
| Request | Receive your email with site access and confirm access with Operator. Share egress IP(s)/ranges for allowlisting. | Submit email and provide technical contact. |
| Grant access to sandbox | Grant access to your own sandbox operator and site. | — |
| Share credentials | Create Identity Platform Application for Integration Partner. Send client_id, client_secret, token endpoint, and base URL. Share Sandbox siteId. | Store client_secret server‑side only. |
| Onboarding survey | — | Complete survey (covers expected call frequency, data volume, and use‑case details). |
| Go live meeting | Review survey responses and performance of integration against Sandbox site. | Deploy a stable version against Sandbox for at least 48 hours. Schedule and participate in the call to review performance and address any issues. |
| Provision production | Enable requested production site access. | — |
| Share production credentials | Send production siteId (existing credentials remain the same). | Switch to production values and run smoke tests. |
| Go‑live | Monitor traffic and health. | Begin production traffic. |
Adding Operators and Sites
If you require access to additional operators or sites, email our support team with your request. Once we receive approval from the relevant customer, we will enable access using your existing credentials — no changes are required on your side.