API — Vue d’ensemble
Cette section documente l’API Datalgeria de manière strictement technique: base URLs, authentification, conventions, endpoints.
Base URLs
| Surface | Base |
|---|---|
| Backend REST | https://<your-backend-host>/api |
| Gateway Marketplace | https://<your-backend-host>/gateway |
Note: l’export OpenAPI du Marketplace construit servers[0].url à partir de PUBLIC_GATEWAY_BASE_URL si défini, sinon https://<host>/gateway.
Deux familles de clés
Platform API keys (api_keys)
- Préfixe:
dlk_... - Usage: sécuriser certaines routes backend (ex:
POST /api/kyc/public/sessions) - Gestion: via
/api/api-keys(dashboard) - Headers:
x-api-keyouAuthorization: Bearer
Marketplace API keys (marketplace_api_keys)
- Préfixe:
dk_live_...(oudk_test_...) - Usage: appeler des APIs publiées via
/gateway/... - Gestion: via
/api/api-marketplace/...(subscriptions + keys)
Démarrage rapide — KYC
curl -X POST "https://<your-backend-host>/api/kyc/public/sessions" -H "Content-Type: application/json" -H "x-api-key: dlk_<...>" -d '{"instanceKey":"<public_instance_key>","mode":"prod"}'
Démarrage rapide — Marketplace → Gateway
- Lister les APIs publiées:
curl -X GET "https://<your-backend-host>/api/api-marketplace/apis?limit=10&offset=0" -H "Content-Type: application/json"
- S’abonner à un plan (renvoie une première clé
dk_live_...):
curl -X POST "https://<your-backend-host>/api/api-marketplace/apis/<apiId>/subscribe" -H "Content-Type: application/json" -H "Idempotency-Key: <uuid>" -d '{"planId":"<planId>","name":"Default"}'
- Appeler via le Gateway:
curl -X GET "https://<your-backend-host>/gateway/<publisherSlug>/<apiSlug>/v/<version>/v1/health" -H "x-api-key: dk_live_<...>"
Réponses & erreurs
- Beaucoup de routes backend renvoient
{ ok: true, ... }en succès. - Les erreurs peuvent être structurées (
sendError) ou minimalistes ({ error: "..." }). - Voir la page Erreurs & conventions pour le format et les codes.