Référence de l'API

Clés d'API

Les clés de l'API et du connecteur MCP. Le secret n'est affiché qu'une fois.

Points de terminaison · 5

POST Créer une clé
GET Lister les clés
GET Récupérer une clé
POST Renouveler une clé
DELETE Révoquer une clé

L'objet

Champ	Saisir	Description
`id`	string	Identifiant unique, commençant par key_.
`name`	string
`prefix`	string	Les premiers caractères, pour distinguer les clés.
`secret`	string	La clé complète. Seulement dans la réponse qui la crée ou la renouvelle.
`created_at, last_used_at`	timestamp

POST/api-keys

Créer une clé

La nouvelle clé agit au nom de la même personne que la clé utilisée pour l'appel.

Paramètre	Saisir		Description
`Idempotency-Key`	en-tête	obligatoire	Une valeur unique pour cette action, de 8 à 200 caractères. Voyez Idempotence.
`name`	string	obligatoire	Jusqu'à 80 caractères.

Requête

bash

curl -X POST "https://api.esorasign.com/v1/api-keys" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Warehouse sync" }'

Réponse

json

{
  "id": "key_0P3C4DSA7Lc360a9Y6yNd1",
  "object": "api_key",
  "name": "CRM integration",
  "prefix": "sk_live_Xp4q",
  "secret": "sk_live_Xp4q…",
  "created_at": "2026-11-01T11:58:20.000Z",
  "last_used_at": null
}

GET/api-keys

Lister les clés

Les clés actives, les plus récentes d'abord.

Paramètre	Saisir		Description
`limit`	integer	facultatif	Nombre d'objets à renvoyer, de 1 à 100. Par défaut 20.
`starting_after`	string	facultatif	Le next_cursor de la page précédente. Omettez-le pour la première page.

Requête

bash

curl "https://api.esorasign.com/v1/api-keys" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{
  "object": "list",
  "data": [
    {
      "id": "key_0P3C4DSA7Lc360a9Y6yNd1",
      "object": "api_key",
      "name": "CRM integration",
      "prefix": "sk_live_Xp4q",
      "created_at": "2026-11-01T11:58:20.000Z",
      "last_used_at": "2026-11-02T14:04:58.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

GET/api-keys/{id}

Récupérer une clé

Requête

bash

curl "https://api.esorasign.com/v1/api-keys/key_0P3C4DSA7Lc360a9Y6yNd1" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{
  "id": "key_0P3C4DSA7Lc360a9Y6yNd1",
  "object": "api_key",
  "name": "CRM integration",
  "prefix": "sk_live_Xp4q",
  "created_at": "2026-11-01T11:58:20.000Z",
  "last_used_at": "2026-11-02T14:04:58.000Z"
}

POST/api-keys/{id}/roll

Renouveler une clé

Révoque la clé immédiatement et en renvoie une nouvelle portant le même nom.

Paramètre	Saisir		Description
`Idempotency-Key`	en-tête	obligatoire	Une valeur unique pour cette action, de 8 à 200 caractères. Voyez Idempotence.

Requête

bash

curl -X POST "https://api.esorasign.com/v1/api-keys/key_0P3C4DSA7Lc360a9Y6yNd1/roll" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Réponse

json

{
  "id": "key_6Yp1sD4hK8mQ2vB0nX5cRw",
  "object": "api_key",
  "name": "CRM integration",
  "prefix": "sk_live_Xp4q",
  "secret": "sk_live_Rm7t…",
  "created_at": "2026-11-01T11:58:20.000Z",
  "last_used_at": "2026-11-02T14:04:58.000Z"
}

DELETE/api-keys/{id}

Révoquer une clé

Elle cesse de fonctionner immédiatement.

Requête

bash

curl -X DELETE "https://api.esorasign.com/v1/api-keys/key_0P3C4DSA7Lc360a9Y6yNd1" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{ "id": "key_0P3C4DSA7Lc360a9Y6yNd1", "object": "api_key", "deleted": true }