Link Generation

GET /v1/link/atlas

Returns a Doorstep Atlas URL for a specified tracking session. Doorstep Atlas is a web app for replaying individual deliveries to understand what happened during a delivery, and can be launched from within your application.

Requires an API key sent as a Bearer token in the Authorization header.

Request

Query Parameters

Parameter	Type	Required?	Description
sessionID	string	Yes	Unique identifier for the session as passed into the Doorstep SDK. Example: a7fcaea4-9a2c-3001-956d-e08b4560267f

Example Request

curl "https://api.core.doorstep.ai/v1/link/atlas?sessionID=a7fcaea4-9a2c-3001-956d-e08b4560267f" \
  -H "Authorization: Bearer $API_KEY"

Response

200

A link to the Atlas tracking session.

Response Body

Field	Type	Description
status	number	Status of the request.
message	string	A description of the result.
link	string	The generated link to the Doorstep Atlas application.

Example Response

{
  "status": 200,
  "message": "Link created successfully",
  "link": "https://atlas.doorstep.ai/clientName?id=f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

400

A required parameter is missing. For example, sessionID was not provided.

{
  "status": 400,
  "code": "bad_request",
  "message": "Missing required parameter: sessionID"
}

401

The API key is missing or invalid.

{
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized"
}

404

No tracking session was found for the provided sessionID.

{
  "status": 404,
  "code": "not_found",
  "message": "No session found for sessionID: a7fcaea4-9a2c-3001-956d-e08b4560267f"
}

500

Something went wrong on our end. Try the request again later.

{
  "status": 500,
  "code": "internal_server_error",
  "message": "An unexpected error occurred"
}

Link Structure

Generated links have the following structure:

https://atlas.doorstep.ai/[clientName]?id=[uuid]

The id parameter is the internal Doorstep session UUID resolved from your sessionID.