Nexra
Start in the sandbox

Build · Reference

API Reference

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

Download OpenAPI

Connect a provider account

Create and test a sandbox connection in your application's project, then choose its exact operation in Nexra Connect → Gateway. External clients need a reviewed published MCP server and explicit tool grants.

  1. Choose an implemented connector and check its account, country and API access requirements.
  2. Authorise the provider connection in your workspace project and test its health.
  3. Discover a capability, inspect its schema, then run a bounded read with that exact selection.
MCP, API, CLI and SDK connection examples
json
{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "search_capabilities",
    "arguments": {
      "query": "customers",
      "mode": "read",
      "limit": 5
    }
  }
}

Use the API origin in the setup guide. MCP calls require initialisation, the returned session header and negotiated protocol version. Gateway REST and SDK use MCP OAuth tokens; API Sandbox product keys and CLI console sessions have separate roles. These examples discover capabilities and do not execute provider writes.

Read connection setupOpen connector Gateway

API Sandbox runs assigned API products. Connector samples run in Gateway. Sample-data checks and test receipts do not grant production approval.

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.

Ask Nexra AgentSelect an application