Créer une API Key

Permet au propriétaire de l'organisation de créer une API Key pour un Agent ou un Workflow de l'organisation.

Cet endpoint permet d'émettre une nouvelle API Key pour un Agent ou un Workflow donné et de définir si la clé dispose de l'autorisation de gestion des versions. Une fois créée, l'API Key renvoyée peut être utilisée pour appeler les endpoints de niveau ressource de cet Agent ou Workflow.

Méthode de requête

POST

URL de la requête

https://api.${endpoint}/v1/org/api-key/create

Authentification de la requête

Utilise l'authentification Basic avec DevKey / DevSecret au niveau du compte ; le compte appelant doit être le propriétaire de l'organisation.

Requête

Exemple de requête

curl -X POST 'https://api.${endpoint}/v1/org/api-key/create' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -H 'Content-Type: application/json' \ -d '{ "org_id": "p-xxxx", "agent_id": "68d0f1a2b3c4d5e6f7a8b9c0", "is_publish": true }'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/api-key/create' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "agent_id": "68d0f1a2b3c4d5e6f7a8b9c0",
    "is_publish": true
  }'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Basic ${BASIC_TOKEN}	Utilisez le Basic Token obtenu en encodant `DevKey:DevSecret` en Base64.
Content-Type	application/json	Format du corps de la requête.

Paramètres de la requête (Body Parameters)

Champ	Type	Description	required
org_id	String	ID de l'organisation, disponible via l'endpoint Interroger la liste des organisations.	true
agent_id	String	ID de l'Agent pour lequel créer l'API Key. Exclusif avec `workflow_id` : un seul des deux peut être fourni.	false
workflow_id	String	ID du Workflow pour lequel créer l'API Key. Exclusif avec `agent_id` : un seul des deux peut être fourni.	false
is_publish	Boolean	Indique s'il faut activer l'autorisation de gestion des versions (import, liste des versions, publication, restauration) pour cette API Key. Définit uniquement l'autorisation et ne déclenche aucune publication. Doit être un booléen JSON `true` ou `false` ; les valeurs telles que `"true"` ou `1` ne sont pas prises en charge.	true

Remarques :

Exactement une valeur non vide doit être fournie pour agent_id ou workflow_id. Si les deux, aucun, ou une chaîne vide sont fournis, une erreur de paramètre est renvoyée.
L'ID doit correspondre au type de ressource : transmettre un ID de Workflow via agent_id, ou un ID d'Agent via workflow_id, renvoie une erreur de type non concordant.
Chaque Agent ou Workflow peut posséder au maximum 10 API Keys. Une fois la limite atteinte, supprimez une clé existante avant d'en créer une nouvelle.
Le nom de la nouvelle API Key est généré automatiquement au format api- suivi de 12 caractères aléatoires. Vous pouvez le consulter ou le modifier sur la page des clés API de la console.
Cet endpoint est limité par compte : 10 appels maximum par minute et par compte.

Réponse

Exemple de réponse

{ "code": 0, "message": "OK", "data": { "api_key": "app-xxxxxxxxxxxxxxxxxxxxxxxx" } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "api_key": "app-xxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
api_key	String	L'API Key nouvellement créée, utilisée pour appeler les endpoints de niveau ressource de l'Agent ou du Workflow correspondant.

Conservez l'API Key renvoyée en lieu sûr. La réponse contient l'en-tête Cache-Control: no-store ; ne conservez pas la clé en clair dans les journaux ou les caches.

Réponse en cas d'échec

Champ	Type	Description
code	Integer	Code d'erreur.
message	String	Détails de l'erreur.

Codes d'erreur

Code d'erreur	Description
40000	Erreur de paramètre, par exemple : paramètre obligatoire manquant, `is_publish` n'est pas un booléen, `agent_id` et `workflow_id` ne respectent pas la règle « exactement un », ou la ressource a atteint sa limite d'API Keys.
40101	L'en-tête de requête `Authorization` est vide.
40104	Le compte actuel n'est pas le propriétaire de l'organisation.
40324	DevKey ou DevSecret incorrect.
40348	L'Agent ou le Workflow n'existe pas ou n'appartient pas à l'organisation.
403204	L'ID fourni ne correspond pas au type de ressource (Agent / Workflow).

Codes d'état

Code d'état	Description
200	Succès
400	Erreur de paramètre
401	Non autorisé
403	Autorisation insuffisante
429	Requêtes trop fréquentes
500	Erreur du serveur