Skip to content

Obtenir une clé API

Demander une clé API technique à Wakastart en précisant application, environnement, client, droits, adresses IP et expiration, puis la réceptionner.

GuideDeveloper
Duration
10 min

This page has not been translated yet and is shown in French.

Les clés API sont émises par l'équipe Wakastart, qui vérifie que les droits demandés correspondent à votre usage. Ce guide indique quoi préparer pour obtenir du premier coup une clé limitée au strict nécessaire, et comment la réceptionner.

Avant de commencer

  • Listez les opérations de l'API publique que votre serveur doit appeler, avec le droit qu'exige chacune (voir la référence API).
  • Identifiez les adresses IP sortantes de vos serveurs, si elles sont fixes.

Préparer la demande

Rassemblez ces informations, une demande par clé :

InformationExemplePourquoi
Nom de la clésynchro-annuaire-prodRetrouver la clé dans les journaux et lors de la révocation
ApplicationMon App (EXAPP1)La clé n'agit que sur cette application
EnvironnementprodUne clé par environnement
ClientClinique Exemple (EXCLI1)Périmètre des utilisateurs et des équipes
TypeClé techniqueElle survit au départ d'une personne
Opérations et droitsLister les utilisateurs (users.read), inviter (invitations.create)Wakastart choisit le profil qui porte ces droits, et aucun autre
Niveau d'administrationAdministrateur clientNiveau minimal exigé par vos opérations
Adresses IP autorisées203.0.113.10, 198.51.100.0/24La clé est refusée depuis toute autre adresse
Expiration2027-04-30Date à laquelle la clé cesse de fonctionner
Usage« Synchronisation nocturne des comptes depuis notre SIRH »Description conservée avec la clé

Les plages d'adresses acceptées sont les adresses IPv4 exactes et les blocs /24 et /16.

Envoyer la demande

  1. Ouvrez une demande auprès du support Wakastart avec ces informations.
  2. Indiquez la personne qui recevra la clé et le canal sécurisé à utiliser (gestionnaire de secrets partagé, par exemple).

Résultat : Wakastart crée la clé et vous la transmet par ce canal. La clé complète, de la forme sk_ suivie de 40 caractères, n'est affichée qu'une seule fois à sa création : Wakastart n'en conserve que l'empreinte et ne pourra pas vous la renvoyer.

Warning

Dès réception, rangez la clé dans votre gestionnaire de secrets (voir Stocker une clé en sécurité) et supprimez toute autre copie. Une clé exposée doit être révoquée immédiatement.

Vérifier le résultat

Faites un premier appel avec la clé (voir Appeler l'API avec une clé). Résultat attendu : 200 sur une opération couverte par les droits demandés, 403 « Droit applicatif requis : … » sur une opération qui ne l'est pas.

Voir aussi