Référence API•stable•Mis à jour 2026-07-08

Vue d’ensemble

Documentation Kadryn pour Vue d’ensemble.

Understand le API reference model.

Périmètre

Cette page décrit le comportement partagé utilisé par plusieurs endpoints API Kadryn.

Authentification

Utilisez une clé API Kadryn dans le header Authorization.

Authorization: Bearer $KADRYN_API_KEY

Gardez les clés API côté serveur. Ne les exposez pas dans les navigateurs, apps mobiles, URLs ou logs client.

Conception des requêtes

  • Utilisez JSON request bodies.
  • Envoyez des métadonnées stables pour project, feature et environment.
  • Utilisez des idempotency keys pour les écritures retryables.
  • Preserve traceparent ou un equivalent trace context.
  • Évitez d’envoyer des secrets ou des credentials provider dans les métadonnées.

Conception des réponses

Les réponses Kadryn doivent être traitées comme du JSON structuré. Stockez les identifiants, request IDs et références de trace lorsque vous aurez besoin de debug ou de support plus tard.

Erreurs

Gérez séparément les erreurs d’authentification, d’autorisation, de validation, de policy, de rate limit, de provider et de serveur. Ne retryez pas les erreurs de policy ou de validation non retryables sans changer l’entrée.

Notes de production

  • Bound retries avec backoff.
  • Keep payloads petit et explicit.
  • Utilisez cursor pagination pour grand result sets.
  • Record request IDs sans logging secrets.
  • Validez réponses at votre intégration boundary.

Pages liées