Premiers pas avec l'API Zonos

Remarque : Zonos utilise désormais GraphQL comme API principale avec une prise en charge complète des fonctionnalités. Les points de terminaison REST sont maintenus avec une prise en charge limitée pour les intégrations héritées uniquement. Pour les nouvelles intégrations, veuillez utiliser notre API GraphQL.

L'API REST Zonos propose des URL orientées ressources, renvoie des réponses encodées en JSON, accepte des corps de requête encodés en formulaire et utilise les codes de réponse HTTP et l'authentification standard.

Pour accéder à l'API Zonos, vous aurez besoin d'une clé API. La même clé API sera utilisée à des fins de test et une fois l'intégration en production. La clé API sert à authentifier les requêtes.

Périodiquement, nous ajouterons des champs à notre API. Afin d'éviter les erreurs une fois que vous êtes intégré à notre API, nous vous recommandons d'ignorer les champs inconnus.

Authentification 

Zonos utilise des clés API pour autoriser l'accès à l'API. Vous pouvez créer un nouveau compte Zonos et une clé API ici.

La clé API sera incluse dans toutes les requêtes API adressées au serveur dans un en-tête de la forme suivante :

serviceToken: meowmeowmeow

Remarque : Assurez-vous de remplacer meowmeowmeow par votre clé API.

Version 

Pour accéder à la version de l'API REST, envoyez l'en-tête zonos-version. Consultez la documentation API correspondante pour les informations d'en-tête appropriées, le cas échéant et si nécessaire.

Si aucune version n'est spécifiée, la valeur par défaut sera la dernière version prise en charge.

L'en-tête de version actuel est zonos-version: 2021-01-01.