Authentication

How this API authenticates requests, and where your API keys live.

Parcel Events Sandbox API declares the schemes below. Each operation documents which schemes it requires; public operations need no credentials.

Your API keys

API key (header)

For operations using this scheme, pass your key in the Parcel-API-Key request header.

curl arguments for operations using this scheme (add the operation URL):

-H 'Parcel-API-Key: YOUR_API_KEY'

HTTP Bearer

For operations using this scheme, send your token in the Authorization header.

Token format: opaque.

curl arguments for operations using this scheme (add the operation URL):

-H 'Authorization: Bearer YOUR_API_KEY'

A request using the declared server and authentication requirements:

curl --globoff -X GET -H 'Parcel-API-Key: YOUR_API_KEY' 'https://api.parcel-events.example/v1/pickups'