Skip to main content

Get started

The AfCFTA Secretariat admits your organisation and enables Sandbox access. Your system then obtains an OAuth 2.0 client-credentials token from the installation's ITS realm and calls the Sandbox partner HTTPS entry through NGINX. NGINX routes the request; ITS Core checks the token's issuer, Sandbox audience, organisation, country, delegation and operation permissions. No partner client certificate is required.

  1. Read Before you begin and ask the Secretariat to admit your organisation.
  2. In the Portal's System integration area, generate a Sandbox credential and store its secret securely.
  3. Use the Sandbox entry and token URL to make the four machine calls in Onboarding.
  4. After an authorised operator reviews the evidence and approves Live access, generate a separate Live credential. Use it only with the Live partner entry.

Each installation has one Portal for both environments. Live and Sandbox use separate credentials, audiences and business data. There is no public Sandbox human API.

The API reference contains reviewed public routes. An unlisted path or method is closed, even if it exists inside Core. /q/openapi and Swagger UI are not public partner routes. Public document verification, tracking and signing-key discovery use their exact public routes.

Where your calls go​

Every ITS host sits on one domain per installation. Environments gives the domain and the full partner entry URLs. Each host answers only the paths listed for it; anything else gets 404 or 405 from the entry, before it reaches ITS.

HostEnvironmentCredentialWhat it answers
gw-sandbox.its.SandboxSandbox bearer token (audience its-core-sandbox)The /api/v1/etd operations: list, lodge, read, amend (POST …/versions), stamp (POST …/endorsements/{stamp_type}), cancel, acknowledge (POST …/deliveries/ack), attachments (list, attach, download), the PDFs, GET /api/v1/etd/reconciliation/digest and GET /api/v1/etd/rejections (with …/summary). Also the notification feed (/api/v1/notifications), the reference-data reads (GET /api/reference/**), GET /api/v1/intake-limits, GET /api/v1/transit-rules and GET /api/v1/error-catalogue
gw.its.LiveLive bearer token (audience its-core-live)The same operations as Sandbox
its-api.LiveNoneThe public routes only: GET /api/public/verify/{code}, GET /api/public/track/{serial_no} and …/pdf, GET /.well-known/jwks.json, GET /api/v1/error-catalogue, and the published contracts under /api/public/contracts/
  • A machine token works only on its partner entry. The same token sent to its-api. is refused, because that host serves people signed in to the Portal. A person's token is likewise refused on a partner entry.
  • Notifications and reference data are on the partner entries. A partner system reads its own notices from /api/v1/notifications and the current reference lists from GET /api/reference/**, with the same token it uses for declarations. See Notifications and Reference data.
  • The public routes are Live only. Sandbox has no public verification or tracking.