Skip to content
Page guideCompany settingsCustomer portal

Developers (API keys and webhooks)

The Developers page of the portal: the API keys, Webhooks and Docs tabs, every field of the key and endpoint forms, and what each button changes.

4 min readLast updated
On this page

Connect your own systems (an ERP, a web shop, a script) to your courier: place and track orders by API and get order updates by webhook. Open Developers from your account menu; it is listed for the primary contact only. Keys and webhooks act for your whole company, so only the primary contact manages them; anyone else who opens the page sees Only your primary contact can manage this on those tabs and can read Docs. For the task step by step, see Connect your systems with API keys and webhooks.

At a glance

TabWhat it does
API keysCreate, rotate and revoke the keys your systems sign in with
WebhooksThe URLs that receive order and invoice events
DocsHow to use the API and check webhook signatures

API keys

The Developers page, API keys tab, with one key (only its first characters are shown)
The API keys tab

Create key (or Create your first key) opens Create an API key:

FieldWhat to enterRequiredNotes
Namee.g. "ERP integration"YesUp to 60 characters
What can this key do?Read orders, Create and cancel orders, Get price quotesAt least one
Speed limit30, 60, 120, 600 or 3000 requests per minuteYes60 by default. Your courier's plan must include API access. Above it, requests are refused with a 429 error until the minute is over.

After Create key, Your new API key shows the key once. Copy it and store it safely: only a fingerprint is kept, so it can't be shown again.

The key list

ColumnShows
NameThe name and its speed limit
KeyThe first characters of the key
CanIts permissions
Acts asThe contact the key works as. Not active: requests are refused. Change the contact. when that person lost access.
Last usedWhen it was last used, or Never
StatusActive, Expiring (with when it stops), Expired or Revoked
ButtonWhat it does
ContactChanges which contact the key acts as. The key can do no more than that contact can in the portal; the key itself stays the same.
RotateCreate replacement key gives a new key with the same permissions. The old one keeps working for 24 hours, then stops.
RevokeRevoke key stops the key at once; its requests are refused with a 401 error. Can't be undone.

Webhooks

The Webhooks tab with one endpoint, its events and its buttons
The Webhooks tab

Add endpoint (or Add your first endpoint) opens Add a webhook endpoint:

FieldWhat to enterRequired
URLa full address, like https://example.com/hooksYes
Send me: ordersOrder created, Status changed, ETA changed (set or moved by 5 minutes or more), Arriving soon, Attempt failed, Delivered, Cancelled. All start ticked.At least one event
Send me: invoicesInvoice issued, Invoice paid, Invoice overdue, Invoice voided (when you can view invoices)

Each call is a signed POST with JSON; your server should answer with any 2xx status within 10 seconds. After saving, Your signing secret is shown once.

Each endpoint

ControlWhat it does
On / OffPauses or resumes sending without removing the endpoint
Payload badgePayload v2, or Payload v1 (legacy) for older endpoints
Send test eventSends a sample call and opens the log
Delivery logThe last 50 attempts, each as Delivered, Waiting, Retrying or Gave up, with Replay. A failed call is retried after 1 minute, 5 minutes, 30 minutes, 2 hours and 6 hours.
Switch to v2Moves a legacy endpoint to the full payload and all events
New secretCreate new secret: for 24 hours every call carries two signatures (new and old secret), then only the new one; update your system within that time
RemoveRemove endpoint: stops sending; events still being retried are dropped

If your courier's plan does not include API access, you cannot add an endpoint or change its URL, events or payload version. An endpoint you already have keeps delivering, and you can still switch it off, test it, change its secret or delete it.

Docs

API documentation walks through: sending your key in the Authorization header, getting a price (also for an address that isn't in your address book), placing an order with an Idempotency-Key, the PRICE_CHANGED answer, reading, listing and cancelling orders, labels and proofs of delivery, your address book, permissions, limits and errors, the webhook payload and checking the NemiRoute-Signature header. OpenAPI document downloads the machine-readable description for Postman or code generators.

Good to know

  • Give each system its own key, so you can switch one off without touching the others.
  • A revoked, expired or unknown key gets a 401 error.

Still stuck?

Ask your courier company: they can see your account. Or tell us what you were trying to do.

Contact us