API
Créer une application
Une application est l'identité de votre outil auprès de l'API. On les gère dans l'espace client, Mon compte › Applications.
Créer une application
L'assistant demande, étape par étape :
- Le nom et une description : ils apparaissent dans votre historique et, pour une application web, sur l'écran d'accord que voient vos utilisateurs.
- Le type :
- Serveur : votre outil obtient lui-même ses jetons, avec son identifiant et son secret ;
- Site web : vos utilisateurs se connectent avec leur compte Adion Cloud. Donnez vos adresses de retour, en
https://(http://seulement pourlocalhost), dix au plus.
- Les droits (scopes) : ce que l'application peut faire. Chaque scope est décrit à l'écran.
- Les projets (application serveur) : limitez l'application à certains projets. Sans choix, elle atteint tous vos projets.
À la fin, l'identifiant (client_id) et le secret s'affichent. Le secret n'est montré qu'une fois : rangez-le dans le coffre de votre outil.
Les scopes
Un scope est une famille de gestes. Les plus utiles :
| Scope | Permet de |
|---|---|
service.read, service.write | Lire et gérer vos services |
project.read, project.write | Lire et gérer vos projets |
billing.read, billing.write | Lire vos factures, gérer la facturation |
dns.read, dns.write, dns.delete | Lire, modifier, supprimer des enregistrements DNS |
email.read, email.write, email.delete | Gérer la messagerie, ses boîtes et ses alias |
hosting.read, hosting.write, hosting.delete | Gérer vos hébergements web |
sms.service.read, sms.message.send, sms.credit.buy | Lire un service SMS, envoyer, acheter des crédits |
campaign.read, campaign.write, campaign.send | Préparer et envoyer des campagnes |
order.read, order.write | Lire et passer des commandes |
openid, profile, email | Connaître la personne connectée (application web) |
La liste complète, avec la description de chaque scope, s'affiche dans l'assistant de création ; elle est aussi décrite sur adion-api.eu.
Les scopes qui gèrent les applications, les autorisations, les droits ou la sécurité du compte ne se donnent jamais à une application.
Le moins possible
Donnez à chaque application les seuls scopes dont elle a besoin. Une application qui lit les factures n'a pas besoin d'écrire les services.
Limiter à certains projets
Une application serveur peut être limitée à un ou plusieurs projets. Elle ne voit alors rien d'autre, même si votre compte a accès à plus. C'est la bonne pratique pour un outil confié à un prestataire.
La fiche d'une application
- Identifiant et secret : générez un nouveau secret si l'ancien a fuité ; l'ancien cesse aussitôt, et ses jetons sont révoqués.
- Désactiver : l'application ne peut plus obtenir de jeton, ses jetons sont révoqués. Réactivable.
- Droits et projets : un scope retiré cesse tout de suite, même pour les jetons déjà émis.
- Journal : les jetons émis, les connexions, les modifications.
- Supprimer : l'application et tous ses accès disparaissent.
Ensuite
Avec l'identifiant et le secret, votre outil obtient ses jetons et appelle l'API. La marche à suivre, les routes et des clients prêts à copier sont sur adion-api.eu.
Les applications que vous avez autorisées
Quand vous vous connectez à un outil tiers avec Adion Cloud, ou qu'un agent IA se branche à votre compte, une autorisation est créée. Retrouvez-les dans Mon compte › Applications et retirez celles qui ne servent plus.