Skip to main content

Authentication and trial limits

Every planning request uses an environment-specific bearer credential:

Authorization: Bearer <credential>

Do not put credentials in URLs, request bodies, source control, screenshots, or application logs. PTV and Hexaly credentials remain inside the Haladir service and are never supplied by the caller.

Trial credentials

A trial credential can be limited by:

  • expiry time and environment;
  • allowed operations;
  • requests per minute and total requests;
  • road-matrix relations per request and over the credential lifetime;
  • maximum manifest and booking-check solve times.

The credential is returned only when it is issued. A replacement credential should be issued if it is lost or exposed.

Inspect the allowance

The operational usage route reports the authenticated trial's limits and remaining allowance:

curl --silent --show-error --fail-with-body \
--header "Authorization: Bearer $SIMEONS_API_KEY" \
"$SIMEONS_API_URL/v1/usage"

GET /v1/usage is a trial-administration route rather than a planning operation, so it is intentionally omitted from the public planning OpenAPI document.

Authentication failures

HTTP statusMeaning
401The bearer credential is missing, malformed, expired, revoked, or invalid for the environment.
403The credential is valid but does not allow the requested operation.
429A rate or total trial allowance has been reached. Use Retry-After only when the response supplies it.

Every error body and response header includes a request ID for support and log correlation.