Créer et gérer des clés API dans Simbase

Une clé API authentifie vos requêtes vers l'API Simbase. Chaque clé reçoit à sa création un ensemble de permissions, qui ne changent plus ensuite. Une clé peut servir plusieurs intégrations, mais une clé par intégration est plus sûre. Vous créez et gérez vos clés dans le tableau de bord, sous Integrations → API.

Créer une clé API

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

2. Allez dans Integrations → API.

3. Cliquez sur Create New API Key.

4. Donnez à la clé un nom qui indique son usage, par exemple Usage Guard Toolkit. Le nom n'est qu'un libellé. Il apparaît dans votre liste de clés et nulle part ailleurs.

5. Sous Resources, définissez les permissions dont la clé a besoin. Voir Permissions ci-dessous.

6. Cliquez sur Create API Key, puis copiez la clé.

La démo ci-dessous montre chaque étape :

Permissions

Les permissions se définissent par ressource, à l'un de trois niveaux. None signifie que la clé n'a aucun accès à cette ressource. C'est la valeur par défaut sur chaque ligne. Read lit les données sans rien modifier. Write crée, modifie et supprime. Sélectionner Write sélectionne aussi Read sur la même ligne, car tout ce qui écrit doit d'abord lire.

Toutes les ressources ne proposent pas les trois niveaux. Account et Usage sont en lecture seule et affichent donc None et Read. SIM card state, Reset, Registration et Auto-disable sont des actions, pas des données, et affichent donc None et Write.

L'arborescence des ressources

Lignes parentes et enfants

SIM cards, Utilities et Integrations ont chacun une flèche à côté du nom. Cliquez dessus pour afficher les permissions individuelles en dessous.

• Définir un niveau sur une ligne parente l'applique à chaque ligne enfant, ou applique le niveau le plus élevé que cette ligne propose. Mettre All resources sur Write donne Read à Account et Usage, car c'est leur maximum.

• Si vous définissez une ligne enfant seule, la ligne parente n'affiche aucune sélection. C'est normal. Une ligne parente n'affiche un niveau que si toutes ses lignes enfants sont identiques.

Choisir un niveau

Accordez le strict nécessaire à l'intégration. Une clé qui ne peut que lire l'utilisation ne peut pas désactiver une SIM si elle fuite.

Dans la référence API, ces permissions apparaissent comme des noms de scope construits sur la même arborescence. SIM card details correspond à simcards.details:read et simcards.details:write.

Paramètres avancés

Activez Show advanced settings pour afficher deux champs facultatifs. Vous pouvez laisser les deux vides.

IP restrictions

Limite la clé à une seule adresse IP de confiance ou à une plage en notation CIDR. Les requêtes venant d'autres adresses sont rejetées. Laissez le champ vide pour ne rien restreindre. La liste des clés affiche alors 0.0.0.0/0 sous Allowed IPs, ce qui signifie n'importe quelle adresse.

Expires in (number of days)

Le nombre de jours entre la création et l'expiration de la clé. Saisissez 31 et la clé expire dans 31 jours. Laissez le champ vide et la clé n'expire jamais.

Les clés à durée 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 API affiche chaque clé du compte : son nom, un Key ID tronqué, le niveau de permission choisi à la création, sa dernière utilisation et sa restriction IP. Last API call s'affiche dans le fuseau horaire du compte, et Allowed IPs indique 0.0.0.0/0 quand il n'y a aucune restriction.

Le Key ID sert uniquement à distinguer les clés. Il est tronqué et ne permet pas de s'authentifier.

Les permissions sont fixées à la création et ne peuvent plus être modifiées. Pour changer ce qu'une clé peut faire, créez une nouvelle clé avec les bonnes permissions, basculez votre intégration dessus, puis supprimez l'ancienne.

Le menu à trois points en bout de ligne propose une seule option : Delete. Une clé supprimée cesse de fonctionner immédiatement et les requêtes qui l'utilisent échouent à l'authentification.

Utiliser la clé

Envoyez la clé comme bearer token dans chaque requête :

Requête

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

La documentation complète des endpoints se trouve sur developer.simbase.com.

Questions fréquentes

Articles associés

• Webhooks : recevez des événements sur une URL que vous contrôlez, sans interroger l'API

• Usage Guard Toolkit (DIY) : une automatisation prête à l'emploi qui utilise une clé API avec la permission Write

• Protection contre le vol : le scope simcards.details:write en pratique

• Fuseau horaire du compte : définit le fuseau horaire de la colonne Last API call