Example governed command
POST /cases
Authorization: Bearer <server-token>
Idempotency-Key: <unique-command-key>
Content-Type: application/json
{ "subject": "Callback request" }Start with one governed operation
Saleringo API integration boundary
Review one complete request, response, permission, idempotency, and failure contract before requesting the full approved integration package.
CONTRACT WORKBENCHSERVER → SALERINGO
POST
/cases- Permission
- case.create
- Idempotency
- required
- Response
- typed
- Trace
- request ID
Implement only the operations and permissions published for your approved scope.
IMPLEMENTATION OUTCOME
Implement only the operations and permissions published for your approved scope.
The repository contract currently validates 293 governed operations. Customer availability still depends on the signed scope and supplied credentials.
- ReadGET operations state their permission, query fields, pagination, and response shape.
- CommandSupported writes use a unique Idempotency-Key and may require a current version or stronger verification.
- DecodeTreat authentication, permission, conflict, validation, throttling, and service failures differently.
- ObservePreserve the request ID so your team and Saleringo can discuss the same attempt.
REQUEST → RESULT
Keep the request, result, and evidence together.
Example accepted result
HTTP 201
X-Request-Id: req_...
{ "id": "case_...", "status": "open" }RECOVERY CONTRACT
A retry is not the answer to every failure.
StatusMeaningClient action
401Credential is missing, expired, or invalidStop; refresh through the approved server flow.
403Identity lacks the exact permission or scopeDo not retry; request an access review.
409State, version, idempotency, or approval conflictsRead the conflict and reconcile before another command.
422The request does not match the published schemaCorrect the named fields; do not retry unchanged.
429The integration is sending too quicklyHonor the supplied wait guidance and apply backoff.
5xxA temporary service failure may have occurredPreserve IDs; retry only when the operation permits it.
IMPLEMENTATION SUPPORT
Bring one operation. Leave with the next test your team can run.
Do not send credentials, customer secrets, or raw payment data. Include the contract version, environment, operation, timestamp, and non-sensitive correlation ID.