Référence de l’API

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é.

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.

{
  "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.

• MessagesEnvoyer et recevoir des SMS5 opérations
• Numéros de téléphoneProvisionner et gérer des numéros de téléphone canadiens15 opérations
• ComptesGestion du compte et clés API24 opérations
• Conformité / LCAPGestion du consentement LCAP et des désabonnements12 opérations
• Conformité / LPRPDEConformité en matière de protection de la vie privée et droit à l’effacement1 opération
• WebhooksEnregistrer des points de terminaison pour recevoir des notifications d’événements11 opérations
• VérificationVérification de numéro de téléphone par code de vérification (NPU) envoyé par SMS, avec supplément facturé par vérification5 opérations
• TarifsPrix actuels par envoi, pour qu’un intégrateur puisse estimer un coût avant d’envoyer1 opération
• ContactsGérer les numéros de téléphone et les métadonnées des contacts5 opérations
• Groupes de contactsRegrouper des contacts et envoyer des diffusions de groupe8 opérations
• ListesListes de contacts d’autorisation et de blocage assignables aux clés API7 opérations
• ModèlesStocker des modèles avec une partie par canal, en anglais et en français, et publier des versions pour envoyer par identifiant ou alias8 opérations
• CourrielsEnvoyer et lire des courriels13 opérations
• Domaines de courrielVérifier des domaines d’envoi pour le courriel6 opérations
• Suppressions de courrielGérer les listes de suppression de courriels3 opérations
• Modèles de courrielStocker des modèles de courriel et publier des versions à envoyer par identifiant ou par alias8 opérations
• PushEnvoyer des notifications push par APNs et FCM avec vos propres identifiants15 opérations
• DestinatairesLes coordonnées de chacun de vos utilisateurs, indexées par votre propre identifiant d’utilisateur5 opérations
• NotifyUne notification à l’un de vos utilisateurs, par push, SMS ou courriel dans l’ordre de votre choix, facturée seulement sur le canal qui la livre3 opérations

L’API de gestion de HonkIO Auth (/v1/auth-apps) a sa propre référence, avec ses guides et ses exemples : Référence de l’API Auth.