Explorer la référence API Boxis

Explorer la référence API

La référence est une seule page. Elle liste chaque section du catalogue Boxis, les paramètres de chaque commande, et un exemple en JSON, Shell, PHP, Python et Node.js.

Ouvrir la référence

Ouvrez la référence API. Elle se lit sans compte. Exécuter une commande demande une clé de projet et une requête signée depuis votre application. La page ne connecte pas votre compte et n’exécute pas l’appel à votre place.

Recherche

Le champ en haut de la liste latérale filtre les sections et les commandes. Une recherche sendSMS laisse cette commande et masque les autres. Vider le champ réaffiche toute la page.

Sections

Chaque entrée latérale est un chemin de section, comme /sms ou /domain. En service signifie que les commandes s’exécutent. Réservé signifie qu’un appel renvoie HTTP 501 et le chemin canonique. /dns est la section des zones. /domain/zone n’est qu’un alias de la même section. /domain reste l’enregistrement : contacts, serveurs de noms, renouvellement, verrou et DNSSEC.

Un lien de section reste sur cette page. L’adresse se termine par une ancre, par exemple /sms.

Une commande

Ouvrez une commande pour voir sa route, si elle lit ou écrit, et ses paramètres. Les onglets d’exemples montrent le même appel en JSON, Shell, PHP, Python et Node.js. Remplacez les exemples. Ne commitez pas le secret.

Exemples en service aujourd’hui : GET /sms/credits lit le crédit SMS, POST /sms/messages envoie un SMS, DELETE /sms/messages/scheduled annule un SMS programmé. L’appel HTTP est toujours un POST. Le verbe de la route est la méthode signée.

Téléchargez l’OpenAPI JSON ou YAML en haut de la référence et importez-le dans votre client HTTP. Le fichier utilise les six mêmes en-têtes de signature.