Developer quickstart
Plan your first connection, choose the right records, and understand what a successful request proves.
Before you start
You can read these guides and the API reference without an account. Organisation owners and admins manage API keys in Settings → API. Your organisation’s existing access rules still apply.
Use synthetic records for testing. The self-service sandbox and complete worked workflow are being prepared; this guide does not yet offer a runnable sandbox. Do not use a production workspace as a substitute.
Map your workflow
A movement is the assurance case for a material journey. A load is one vehicle or batch occurrence within it. Several bookings, deliveries, or documents can belong to one movement.
- Identify the organisation and the existing project and location.
- Decide which source record represents a movement and which represents a load.
- Keep the returned Nexus references alongside your source IDs.
- Choose only the scopes your integration needs; keep the credential in server-side secret configuration.
Inspect the current contract
The public OpenAPI document describes the beta request and response shapes. Reading it does not require a key. Check the current limitations before relying on a complete workflow.
curl --fail --silent --show-error \
https://assurance.nexusregen.com/api/openapi.jsonVerify the outcome
A successful request is an acknowledgement, not an assurance approval. File upload, evidence attachment, review, and human approval are separate outcomes. Check the relevant record in Assurance and keep human decisions with the authorised person.
Before going live, verify your mapping, access, retries, corrections, and failure handling with the supported environment and workflow. Never tick off review or delivery merely because a request returned successfully.