Jetons API

Les jetons API vous permettent de connecter vos propres scripts, outils ou automatisations à InfraNest, en utilisant les mêmes actions que celles que vous effectueriez sinon manuellement dans l'application. Cet article s'adresse à toute personne qui souhaite automatiser des tâches plutôt que de les effectuer manuellement.

Vue d'ensemble

• InfraNest dispose d'une API REST complète : tout ce que vous pouvez faire dans l'application, vous pouvez aussi le faire via l'automatisation.
• Vous accédez à l'API en créant une entrée dans Jetons API, qui fait office de clé.
• Chaque jeton peut être limité précisément à ce qu'il est autorisé à faire, et pour combien de temps.

Créer un jeton

1. Allez dans Jetons API et sélectionnez Créer.
2. Donnez un nom au jeton, choisissez ses capacités (ce qu'il est autorisé à faire), et définissez éventuellement une expiration.

3. Sélectionnez Copier pour copier le jeton immédiatement.

WarningCopiez le jeton maintenant — il ne s'affiche qu'une seule fois. Ensuite, vous ne verrez plus qu'un indice des derniers caractères, et il n'y a aucun moyen de le révéler à nouveau.

Choisir les capacités

Les capacités déterminent ce que chaque jeton peut voir ou modifier. Pour chaque domaine, vous pouvez accorder un accès en lecture ou en écriture, et il existe aussi un préréglage en lecture seule ainsi qu'une option d'accès complet. En règle générale, ne donnez à un jeton que ce dont il a réellement besoin.

Chaque domaine couvre plus que son nom ne le suggère :

• Domains & Contacts — domaines, contacts, transferts, serveurs de noms
• DNS — zones, enregistrements, modèles
• Cloud Infrastructure — serveurs, volumes, instantanés, réseaux, pare-feux, équilibreurs de charge, identifiants cloud
• Monitoring — vérifications de disponibilité, incidents, maintenance, pages de statut, ainsi que Certificats et webhooks, automatisations, intégrations et tags
• Drop Catch — domaines surveillés et tentatives de drop-catch
• Members & Teams — membres, invitations, rôles, authentification unique (SSO)
• Billing — abonnement, factures, moyens de paiement, informations de facturation (lecture seule)
• Audit Log — le journal d'audit de votre organisation (lecture seule)
• Data export & import — export de vos données, et import depuis un fichier

NoteLes certificats et les webhooks ne constituent pas des domaines distincts — ils font partie de Monitoring, donc un jeton qui a besoin de l'un ou de l'autre doit avoir accès à Monitoring. Billing et l'Audit Log sont toujours en lecture seule via l'API — modifier un abonnement ou payer une facture ne peut être fait que par une personne connectée à l'application.

Gérer les jetons

1. Allez dans Jetons API pour voir vos jetons existants.
2. Vérifiez la date de dernière utilisation de chaque jeton pour voir s'il est toujours actif.
3. Sélectionnez Retirer sur tout jeton que vous souhaitez révoquer — cela prend effet immédiatement.

TipLa référence complète des points de terminaison se trouve dans l'application — sélectionnez View full API documentation depuis la page Jetons API.

Résolution des problèmes

• Vous recevez une réponse « try again shortly » ? Certaines actions, comme les synchronisations manuelles et « check now », sont soumises à une limitation de fréquence par organisation afin de protéger la plateforme. Attendez un peu et réessayez.
• Vous avez perdu votre jeton ? Vous ne pouvez plus le consulter — créez-en un nouveau et supprimez l'ancien.