Authentification
Les clés API de compte, accès complet ou personnalisé, et où en créer une.
Chaque appel à CPI porte une clé API. Il n'y a ni identifiant client séparé, ni échange OAuth, ni signature à calculer : une clé, envoyée avec la requête.
Créer une clé
Les clés se trouvent dans le tableau de bord, sur l'écran Développeurs du menu du compte, dans l'onglet Clés API.
Un projet a son propre onglet API qui crée le même type de clé, déjà limitée à ce
projet, de sorte que vous ne saisissez jamais d'app_id à la main. Le bac à sable de la référence API
interactive peut aussi en créer une sur-le-champ, pour que vous puissiez essayer une méthode avant de brancher quoi que ce soit
dans votre propre code.
Créer une clé API exige une vérification d'identité, le même contrôle de niveau 2 que Xuda demande avant de fournir un numéro de téléphone, une boîte mail ou une IP portable. Un compte sans rien de vérifié voit une invitation à vérifier avant l'ouverture du formulaire de clé.
Portée : en tant que quel compte agit la clé
Une clé est créée avec l'une de trois portées, et agit toujours sur le compte ou l'application pour lesquels elle a été créée :
- Compte : agit directement sur votre compte, comme vous le feriez depuis une session de tableau de bord connectée. Atteint toutes les méthodes qu'une clé de compte simple peut atteindre.
- Application : créée depuis l'onglet API d'un projet, liée à l'
app_idde ce projet. - VPS Full Stack : émise automatiquement quand vous provisionnez un VPS Full Stack, limitée aux groupes de capacités choisis à la création. Voir VPS Full Stack pour ce que cela couvre.
Accès : complet ou personnalisé
Chaque clé choisit aussi la part de la surface publique qu'elle peut atteindre :
- Accès complet : tout ce que le compte peut faire via l'API, y compris les méthodes ajoutées après la
création de la clé. Les méthodes privées restent exclues quoi qu'il arrive :
private: trueest un mur absolu, vérifié à chaque appel, pas une valeur par défaut que l'accès complet peut remplacer. - Accès personnalisé : une liste d'autorisation explicite que vous construisez en cochant des méthodes dans le formulaire de clé, groupées
par microservice avec les champs de chaque méthode affichés en ligne. Une méthode ajoutée plus tard n'est pas incluse
tant que vous ne revenez pas l'autoriser. Une méthode dont la
clearanceestpublicest toujours accessible, même avec une clé personnalisée sans rien de coché, car une méthode publique n'a besoin ni de session ni d'entrée dans la liste d'autorisation.
Les méthodes qui créent, mettent à jour et listent les clés API (create_account_api_key,
get_app_api_keys et le reste d'api_module) ne sont jamais accessibles avec une clé API, par conception :
un identifiant ne peut pas créer ni modifier des identifiants pour le compte qu'il authentifie. Gérez les clés depuis
le tableau de bord ou depuis une session connectée.
Envoyer la clé
En REST simple, la clé est un paramètre de requête de plus, nommé api_key : un champ du corps JSON
avec POST, un paramètre de chaîne de requête avec GET. Voir
Appeler une méthode pour les deux formes.
Avec MCP, la même clé passe dans un en-tête Authorization: Bearer à la place, il n'y a pas de champ api_key.
Voir MCP.
Une clé API est un identifiant porteur : quiconque la détient agit comme votre compte. Ne l'intégrez jamais dans du code côté client, ne la commitez pas et ne la collez pas dans une capture d'écran partagée. Remplacez une clé immédiatement si elle apparaît à l'un de ces endroits : le remplacement conserve le nom et le mode d'accès et révoque l'ancienne valeur dans la même étape.