Premiers pas avec l’API Boxis

Premiers pas

Appelez les produits Boxis depuis votre application. L’adresse publique est https://api.boxis.net/. Une clé de projet signe chaque requête. Le secret n’est pas envoyé.

Objectif

L’API exécute des commandes du compte sans l’espace client. SMS est en service. Une section réservée répond HTTP 501 et renvoie son chemin canonique. Aucune commande ne s’y exécute tant qu’elle n’est pas publiée.

Prérequis

Un compte Boxis actif.
L’accès aux clés API dans l’espace client. Créer, modifier ou révoquer une clé demande le mot de passe du compte.
La référence API, pour la liste des commandes et les exemples par langage.

Créer une clé

Ouvrez les clés API, onglet Project, puis Create new secret key. Choisissez All, Read only ou Restricted. Vous pouvez fixer une expiration et une liste d’adresses IP source. Une liste vide autorise chaque adresse. Une liste remplie refuse les autres.

La fenêtre d’affichage montre trois valeurs, une seule fois. L’identifiant commence par bxk_. L’autorisation de compte commence par bxu_. Le secret commence par bx_live_. Conservez-les hors du dépôt de code. Le secret ne sert qu’à signer.

Une clé dans l’onglet Legacy est une ancienne clé SMS. Les nouvelles applications utilisent une clé de projet.

Premier appel

Commencez par getAPITimestamp. Cette commande n’envoie pas de SMS. L’appel HTTP est un POST. La route signée est GET /sms/timestamp. Cette route doit être accordée à la clé.

$secret = 'bx_live_...';
$consumer = 'bxu_...';
$body = '{"section":"/sms","command":"getAPITimestamp"}';
$timestamp = (string) time();
$canon = $consumer . "\nGET\nhttps://api.boxis.net/sms/timestamp\n" . $timestamp . "\n" . hash('sha256', $body);
$signature = hash_hmac('sha256', $canon, $secret);

Envoyez ce corps vers https://api.boxis.net/ avec X-Boxis-Key, X-Boxis-Consumer, X-Boxis-Method, X-Boxis-Path, X-Boxis-Timestamp et X-Boxis-Signature. Un succès contient result, message et data. Une requête de plus de 5 minutes, ou envoyée deux fois, est refusée.

Les exemples Shell, PHP, Python et Node.js de chaque commande sont dans la référence API. Les règles de signature sont dans Comment une requête est signée.