Un Clé API authentifie vos requêtes adressées à l'API Simbase. Chaque clé est associée à un ensemble d'autorisations choisies lors de sa création, et ces autorisations sont figées dès lors. Une même clé peut servir à plusieurs intégrations, mais il est plus sûr d'utiliser une clé par intégration. Les clés sont créées et gérées dans le tableau de bord, sous Intégrations → API.

Créer une clé API

1. Connectez-vous à dashboard.simbase.com.

2. Accédez à « Intégrations » → « API ».

3. Cliquez sur « Créer une nouvelle clé API ».

4. Donnez à la clé un nom qui indique à quoi elle sert, par exemple Boîte à outils Usage Guard. Ce nom n'est qu'une étiquette. Il apparaît dans votre liste de clés et nulle part ailleurs.

5. Dans la section « Ressources », définissez les autorisations requises pour la clé. Voir Autorisations ci-dessous.

6. Cliquez sur « Créer une clé API », puis copiez la clé.

Consultez la démo ci-dessous pour obtenir des instructions étape par étape :

Autorisations

Les autorisations sont définies pour chaque ressource, selon l'un des trois niveaux suivants. Aucun signifie que la clé ne peut en aucun cas accéder à cette ressource, et c'est le comportement par défaut pour chaque ligne. Lire récupère des données sans rien modifier. Écrire crée, met à jour et supprime ; en le sélectionnant, on sélectionne également « Lecture » sur la même ligne, car toute opération d'écriture nécessite une lecture préalable.

Toutes les ressources ne proposent pas ces trois éléments. Les rubriques « Compte » et « Utilisation » sont en lecture seule ; elles affichent donc « Aucun » et « Lecture ». Les rubriques « État de la carte SIM », « Réinitialisation », « Enregistrement » et « Désactivation automatique » correspondent à des actions plutôt qu'à des données ; elles affichent donc « Aucun » et « Écriture ».

L'arborescence des ressources

Lignes parent et enfant

Les rubriques « Cartes SIM », « Utilitaires » et « Intégrations » sont chacune accompagnées d'une flèche à côté de leur nom. Cliquez dessus pour afficher les autorisations correspondantes.

• La configuration d'un élément parent attribue à chaque élément enfant le même niveau d'accès, ou le niveau le plus élevé pris en charge par cet élément enfant. Si l'on attribue le niveau « Écriture » à toutes les ressources, les éléments « Compte » et « Utilisation » se voient attribuer le niveau « Lecture », car c'est le niveau le plus élevé qu'ils prennent en charge.

• Lorsque l'on définit un enfant seul, le parent n'affiche aucune sélection. C'est normal. Un parent n'affiche un niveau que lorsque tous ses enfants sont d'accord.

Choisir un niveau

Fournir le strict minimum nécessaire au bon fonctionnement du système. Une clé qui ne permet que la lecture des données d'utilisation ne peut pas désactiver une carte SIM en cas de fuite d'informations.

Dans la documentation de l'API, ceux-ci apparaissent sous forme de noms de portée construits à partir de la même arborescence. Les informations relatives à la carte SIM correspondent à simcards.details : lecture et simcards.details : écriture.

Paramètres avancés

Cochez la case « Afficher les paramètres avancés » pour accéder à deux champs facultatifs. Vous pouvez laisser les deux champs vides.

Restrictions liées à l'adresse IP

Limite l'accès à la clé à une seule adresse IP de confiance ou à une plage d'adresses en notation CIDR. Les requêtes provenant de toute autre adresse sont rejetées. Laissez le champ vide pour n'appliquer aucune restriction. La liste des clés affiche alors 0.0.0.0/0 sous « Adresses IP autorisées », ce qui signifie n'importe quelle adresse.

Expire dans (nombre de jours)

Nombre de jours entre la création et le moment où la clé cesse de fonctionner. Entrez 31 et la clé expirera dans 31 jours. Si vous laissez ce champ vide, la clé n'expirera jamais.

Les clés à durée de vie limitée sont utiles pour les migrations ponctuelles, l'accès des prestataires et tout ce que vous devriez sinon penser à révoquer.

Gérer vos clés

La liste des API affiche toutes les clés du compte : leur nom, un identifiant de clé tronqué, le niveau d'autorisation avec lequel elles ont été créées, la date de leur dernière utilisation et leur restriction d'adresse IP. Le dernier appel API est affiché dans votre fuseau horaire du compte, et « Adresses IP autorisées » indique 0.0.0.0/0 là où il n'y a aucune restriction.

L'identifiant de clé (Key ID) sert uniquement à distinguer les clés les unes des autres. Il est tronqué et ne peut pas être utilisé à des fins d'authentification.

Les autorisations sont définies lors de la création et ne peuvent pas être modifiées par la suite. Pour modifier les droits d'une clé, créez-en une nouvelle avec les autorisations souhaitées, basculez votre intégration sur celle-ci, puis supprimez l'ancienne.

Le menu à trois points situé à la fin de chaque ligne ne comporte qu'une seule option : Supprimer. Une clé supprimée cesse immédiatement de fonctionner, et les requêtes qui l'utilisent échouent à l'authentification.

Utilisation de la clé

Envoyez la clé sous forme de jeton au porteur à chaque requête :

Demande

GET /v2/simcards HTTP/1.1
Host: api.simbase.com
Authorization: Bearer YOUR_API_KEY

La documentation complète relative aux points de terminaison est disponible à l'adresse suivante : developer.simbase.com.

Questions fréquentes

À ce sujet

• Webhooks — recevoir les événements directement sur une URL de votre choix, sans avoir à interroger l'API

• Kit d'outils Usage Guard (à monter soi-même) — une solution d'automatisation prête à l'emploi qui utilise une clé API dotée d'un droit d'écriture

• Protection contre le vol — le simcards.details : écriture champ d'application dans la pratique

• Fuseau horaire du compte — définit le fuseau horaire dans lequel s'affiche la colonne « Dernier appel API »