Deri
Academy
en
TND
/
09 — 10
3 min
How to connect the Deri API and get the access token
Transcript
Download subtitles
0:02
From the E-commerce Platforms section, your store can connect with different sales channels.
0:08
One of the options is the Deri API, designed to integrate your own system with order and shipment management.
0:15
To connect a new platform, tap the plus button.
0:18
This opens the list of available integrations, with Deri API among the options.
0:23
Choosing Deri API opens the connection form.
0:26
No field is required: you can connect right away,
0:30
and optionally assign a branch or an operator within your account.
0:35
The most important field is the webhook URL:
0:38
that's where your system receives real-time notifications whenever an order or shipment status
0:43
changes, or a rider is assigned.
0:46
Save creates the connection.
0:48
This is the key step: the system generates a unique access key,
0:52
which your system will use to authenticate against the API.
0:56
The key is shown only once, for security reasons.
0:59
It must be copied and stored somewhere safe before closing this window,
1:04
because it can't be seen again afterwards.
1:07
Back in the list, the new Deri API connection is now visible,
1:10
along with its identifier and creation date.
1:13
From each connection's menu, you can edit its settings or deactivate it at any time.
1:19
Choosing Edit opens more options to configure:
1:22
you can add a description, change the webhook URL at any time,
1:26
and assign the connection to a specific operator within your account.
1:30
Saving applies the changes right away, and the connection remains active in the list, ready to use.
1:37
With the access key, your system can create and query orders,
1:41
and receive webhook events for status changes, rider assignment,
1:45
and approved destination changes.
1:47
The full technical reference, with every endpoint and the detail of each event,
1:53
is available in Deri's Operators API documentation.
Did you get it?
To connect the Deri API, is any field required?
No, you can connect right away and optionally add more data
Yes, the URL of your own system is required
Yes, you have to upload an SSL certificate
Previous lesson
Cómo configurar la integración con Moova para obtener etiquetas de Shopify
Next lesson
How to invite users to your store: global role or per-branch roles