Prepare the instance
Use the URL of your Ominity instance. Decide which records the integration needs and give its administrator API key the appropriate permissions.
Keep credentials on the server
Store the instance URL and credentials in your server environment. Do not place a privileged API key in a browser bundle, public repository, or client-side request.
Start with a read
The API uses the /api/v1 base path. Begin with GET /cms/pages or GET /commerce/products. Verify the authentication configuration for your instance before connecting a live application.
For example, the first read can target a content collection:
GET /api/v1/cms/pagesThis shows the operation path. Use your instance’s authentication reference for the required credentials and request configuration.
Build the next layer
Choose an SDK or framework package. Handle empty results, denied access, and errors before adding cart operations or customer-specific interactions.
Keep a clear boundary
| Layer | Responsibility |
|---|---|
| Frontend | Render records and make interaction states clear. |
| Server integration | Keep privileged credentials and call the instance. |
| Ominity instance | Apply the configured permissions and supported operations. |
Continue with authentication and access, then make customer context explicit when your application needs it.