Requêtes et réponses

L'API REST utilise JSON sur HTTPS avec la base https://api.click2call.app/v1. Les identifiants métier sont des ULID.

Enveloppes

Une ressource est placée dans data :

JSON
{"data":{"id":"01K00000000000000000000000","name":"Site France"}}

Une collection contient aussi la pagination :

JSON
{"data":[],"meta":{"has_more":false,"next_cursor":null}}

Utilisez limit entre 1 et 100 et le cursor renvoyé par la page précédente.

Créations idempotentes

Toute création exige Idempotency-Key (128 caractères maximum). Réutiliser la même clé pour la même opération renvoie la réponse d'origine avec Idempotent-Replayed: true.

Erreurs

JSON
{
  "error": {
    "code": "validation_failed",
    "message": "Le numéro doit être un numéro français valide.",
    "request_id": "req_01K..."
  }
}
HTTP Code Action
400 bad_request Corriger le JSON ou l'en-tête d'idempotence
401 unauthorized Fournir une clé valide
403 forbidden, origin_forbidden Vérifier permission ou origine
404 not_found Vérifier l'identifiant et l'organisation
409 conflict Résoudre un doublon ou un état incompatible
422 validation_failed Corriger les données métier
429 rate_limited, quota_exceeded Attendre ou augmenter la limite
500 internal_error Réessayer, puis transmettre request_id au support

Branchez votre code sur code et le statut HTTP, jamais sur le texte de message.