Premier appel
Vérifier une clé avec /me et lire les en-têtes de chaque réponse
Authentification
Chaque requête porte la clé dans l'en-tête Authorization, au format
Bearer :
Authorization: Bearer dlt_…Le mot Bearer s'écrit sans tenir compte de la casse (bearer ou BEARER
passent aussi), suivi d'une seule espace. Le secret, lui, se recopie tel
quel : il commence par dlt_ en minuscules, et un seul caractère modifié le
rend inconnu.
Une clé ne fonctionne que sur l'adresse de son espace. Présentée sur
l'adresse d'un autre espace, elle reçoit la même réponse qu'une clé inconnue :
401 invalid-api-key.
Vérifier la clé avec /me
GET /me est l'appel le plus léger : il dit à quel espace la clé appartient et
ce qu'elle peut faire.
curl https://acme.deltia.co/api/v1/me \
-H "Authorization: Bearer dlt_…"{
"organization": { "id": "…", "slug": "acme", "name": "Acme" },
"apiKey": {
"id": "…",
"name": "Make — factures",
"prefix": "dlt_Ab3dE9fG",
"expiresAt": "2027-09-21T10:00:00.000Z"
},
"scopes": [{ "id": "…", "name": "Commercial" }],
"roles": [{ "id": "…", "name": "Direction" }],
"permissions": {
"crm": { "societes": ["read", "create"] },
"facture": { "quotes": ["read"], "invoices": ["read"] }
},
"rateLimit": { "limit": 60, "windowSeconds": 60 }
}Les entités de permissions.crm sont nommées par leur name, l'identifiant
public qu'utilisent toutes les URL du CRM. Une entité supprimée depuis la
création de la clé n'y figure plus.
Les en-têtes de chaque réponse
| En-tête | Contenu |
|---|---|
X-Request-Id | identifiant unique de la requête ; citez-le si vous contactez le support |
X-RateLimit-Limit | le quota de la clé, par minute |
X-RateLimit-Remaining | les requêtes qui restent dans la minute en cours |
X-RateLimit-Reset | l'instant où la fenêtre se libère, en secondes Unix |
Retry-After | sur un 429 seulement : le nombre de secondes à attendre |
Format des réponses
Les réponses sont en JSON. Les dates sont en ISO 8601 (UTC pour les instants,
AAAA-MM-JJ pour les dates seules). Une erreur est au format
Problem Details, avec le type de contenu
application/problem+json.