Démarrage en 3 étapes

  1. Créez votre compte et obtenez l'accès au back-office DZ Relay (cf. devenir marchand).
  2. Générez une clé API dans le back-office sous Paramètres → Clés API. La clé est de la forme dzlk_… et n'est affichée qu'une seule fois.
  3. Faites votre premier appel pour vérifier votre intégration :
    curl -H "Authorization: ApiKey dzlk_..." \
      /api/partner/v1/health
    Le serveur vous renvoie l'identifiant de votre organisation et confirme que votre clé est valide.

Créer un colis

curl -X POST \
  -H "Authorization: ApiKey dzlk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "recipientName": "Hocine Benali",
    "recipientPhone": "0555 12 34 56",
    "weightG": 1500,
    "destinationRelayCode": "DZ-ALG-001"
  }' \
  /api/partner/v1/parcels

Webhooks

Pour recevoir les changements de statut en push, configurez votre URL + secret HMAC dans Paramètres → Webhooks. Chaque notification est un POST signé HMAC-SHA256 — vérifiez la signature via l'en-tête X-Dzrelay-Signature avant de traiter le payload.

Référence complète

Documentation interactive générée à partir de la spec OpenAPI 3 du backend. Vous pouvez aussi récupérer le JSON brut : /v3/api-docs/partner (utilisable avec OpenAPI Generator pour fabriquer un SDK Java / PHP / Go / TypeScript).