Quickstart

From zero to the template library in four steps. Full shapes in the API reference.

1. Register a client

Go to Register, enter the access code from the BoatSmart HQ team, name your application, and pick the scopes you need. Store the client secret immediately; it is shown once.

2. Get a token

Server-to-server integrations use the client credentials grant. Tokens are short-lived; request one per session, not per call.

curl -X POST https://<platform-host>/connect/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d grant_type=client_credentials \
  -d client_id=bsq_your_client_id \
  -d client_secret=your_client_secret \
  -d scope="templates:read"

3. Pull the template library

The base Vessel Inspection Report template with its items. Use updatedSince to sync incrementally.

curl https://<platform-host>/api/v1/integration/templates \
  -H "Authorization: Bearer <access_token>"

4. Go deeper

Directory reads, work-request handoffs, and telemetry ingest are specified in the API reference. Every endpoint needs exactly one scope; requests outside your grant return 403.