Developer guide

Begin with scoped access.

API endpoints, authentication, and capabilities depend on your provisioned environment.

Before the first request

Confirm the base URL and credentials supplied for your environment. Agree on the endpoint, allowed actions, rate expectations, and data scope with the deployment owner.

Build a small integration

Start with a read operation and a sample record your team may access. Validate the response shape and error handling before introducing writes or automated actions.

Design for failure

Handle authentication errors, timeouts, and repeated requests deliberately. Do not retry a state-changing operation without knowing its duplication behavior.

Request environment documentation

The public site does not issue API credentials. Ask for the API contract and examples for your deployment.

Discuss API access

Explore HOJAI

Find the right place to startEsc to close