API Reference

Review operations, schemas, authentication requirements, and generated integration examples from validated OpenAPI specifications.

Download OpenAPI
POST/v1/sandbox/echo

Echo a validated sandbox payload

Bearer credential required

Use an app-scoped sandbox key. Secrets are never embedded in generated examples.

Request schema

application/json schema
{
  "$ref": "#/components/schemas/EchoRequest"
}

Request example

application/json
{
  "message": "Hello from Amakora Developers",
  "reference": "example-001"
}

Code examples

curl
curl -X POST "https://sandbox.api.amakoragroup.com/v1/sandbox/echo" \
  -H "Authorization: Bearer <sandbox_api_key>" \
  -H "Content-Type: application/json" \
  --data '{"message":"Hello from Amakora Developers","reference":"example-001"}'

Responses

200

Validated payload

401

Missing or invalid sandbox credential

422

Payload validation failed

200 response
{
  "message": "Hello from Amakora Developers",
  "accepted": true,
  "reference": "example-001"
}
GET/v1/sandbox/health

Check sandbox service availability

No credential required

This operation can be called without application credentials.

Code examples

curl
curl -X GET "https://sandbox.api.amakoragroup.com/v1/sandbox/health"

Responses

200

Sandbox service is available

200 response
{
  "status": "ok",
  "environment": "sandbox"
}
POST/v1/sandbox/validate

Validate an integration payload without executing it

Bearer credential required

Use an app-scoped sandbox key. Secrets are never embedded in generated examples.

Request schema

application/json schema
{
  "type": "object",
  "additionalProperties": true
}

Request example

application/json
{
  "payload": {
    "name": "Sample integration"
  },
  "operation": "create-example"
}

Code examples

curl
curl -X POST "https://sandbox.api.amakoragroup.com/v1/sandbox/validate" \
  -H "Authorization: Bearer <sandbox_api_key>" \
  -H "Content-Type: application/json" \
  --data '{"payload":{"name":"Sample integration"},"operation":"create-example"}'

Responses

200

Validation result

422

Payload validation failed

200 response
{
  "valid": true,
  "errors": []
}

Try it in the sandbox

Run permitted requests through the authenticated, app-scoped sandbox explorer.