HonkIOHonkIO

Référence

Référence de l’API

Chaque opération de l’API REST HonkIO, une page par ressource : paramètres, corps de requête, réponses, la permission requise et un exemple de requête.

URL de base

Chaque requête va à https://api.honkio.ca en HTTPS, et chaque chemin commence par /v1. Les corps de requête sont en JSON, envoyés avec Content-Type: application/json, tout comme chaque corps de réponse.

Authentification

Envoyez une clé API avec chaque requête, dans l’un de ces en-têtes. Une clé de test (mk_test_) fait les mêmes vérifications qu’une clé réelle sans rien envoyer ni facturer. Authentification et clés API couvre le mode test et les permissions de chaque clé.

En-têteDescription
Authorization: Bearer mk_live_YOUR_KEY

Utilisez mk_live_... en production ou mk_test_... pour les tests.

X-API-Key: mk_live_YOUR_KEY

Solution de rechange à l’en-tête Authorization : envoyez directement mk_live_... ou mk_test_... dans X-API-Key.

Seule la liste de prix (GET /v1/pricing) répond sans clé.

Idempotence

L’envoi d’un SMS, d’une diffusion à un groupe ou d’un courriel lit un en-tête Idempotency-Key. Envoyez une clé unique avec toute requête que vous pourriez réessayer : une répétition avec la même clé renvoie la première réponse au lieu d’envoyer, et de facturer, une seconde fois.

Pagination

Les opérations de liste paginent de l’une de trois façons selon la ressource : page et limit, limit et offset, ou limit et un curseur. Les paramètres et les champs de réponse de chaque opération de liste indiquent laquelle elle utilise.

Erreurs

Une erreur répond avec son statut HTTP et le même corps JSON sur chaque route : un code stable, un message dans la langue de l’en-tête Accept-Language de la requête, le message en anglais et en français, le statut à nouveau et, pour certaines erreurs, une valeur details. Erreurs liste chaque code.

json
{
  "code": "NOT_FOUND",
  "message": "Resource not found.",
  "messageEn": "Resource not found.",
  "messageFr": "Ressource introuvable.",
  "statusCode": 404
}

Explorateur interactif

Pour essayer une requête depuis votre navigateur, l’explorateur interactif exécute chaque opération sur l’API avec votre propre clé. Il est en anglais seulement.

Ressources

Une page par ressource. Chaque opération indique ses paramètres, son corps de requête, ses réponses et la permission requise, avec un exemple de requête.