On this page
API Quickstart
Obtain a sandbox client registration, the approved scope for one public operation, and the one-time credential reveal from the workspace owner or delegated publisher. Store the credential in a secrets manager; the Platform does not reveal it again.
Request
Replace every angle-bracket placeholder. The operation catalog supplies the gateway UID, operation key, method, environment, and request schema.
curl --request POST "https://batoi.com/api/" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-Batoi-Client-Id: <client-id>" \
--header "Authorization: Bearer <one-time-credential>" \
--header "X-Request-ID: example-request-001" \
--data '{
"contract": "batoi.public-api/1",
"gateway": "<gateway-uid>",
"operation": "<published-operation>",
"environment": "sandbox",
"method": "GET",
"request": {}
}'Successful response
A successful response includes the active contract version and hash plus a correlation identifier. Retain the correlation identifier when asking for support.
{
"success": true,
"contract": "batoi.public-api/1",
"gateway": "<gateway-uid>",
"operation": "<published-operation>",
"contract_version": "<version>",
"contract_hash": "<sha256>",
"correlation_id": "<request-id>",
"data": {}
}Next
- Confirm the response contract hash matches the active published reference.
- Exercise only sandbox until production promotion is approved.
- Rotate or revoke the binding immediately if the credential may have been exposed.