Gestion des clés API

Guide complet pour créer et gérer vos clés API.

Aperçu

Les clés API sont le principal moyen de s'authentifier auprès des API YODI. Chaque clé est :

Unique - Vous seul avez accès à vos clés
Sécurisée - Jamais partagée ni journalisée
Révocable - Peut être supprimée à tout moment
Remplaçable - Peut être remplacée sans perte de fonctionnalité
Traçable - Vous pouvez voir quelle clé a fait quelle requête

Création d'une clé API

Endpoint : POST /api-key/create

Via le tableau de bord

Connectez-vous à https://console.yodi.tg
Allez dans Paramètres → Clés API
Cliquez sur Générer une nouvelle clé
Donnez-lui un nom descriptif (ex. "Serveur de production", "Application mobile")
Copiez la clé immédiatement (vous ne la verrez plus !)

Via l'API

curl -X POST "https://admin.yodi.tg/api/api-key/create" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My New Key",
    "description": "Key for my production server"
  }'

Réponse :

{
  "message": "SUCCESS",
  "error": false,
  "data": {
    "id": "key_uuid",
    "key": "sk_live_a1_3f8a2b1c4d5e_1x2y3z",
    "isActive": true,
    "createdAt": "2024-06-01T00:00:00.000Z"
  },
  "status": 201
}

Consulter vos clés

Endpoint : GET /api-key

Liste de toutes les clés API de votre compte :

curl -X GET "https://admin.yodi.tg/api/api-key" \
  -H "Authorization: Bearer YOUR_API_KEY"

Réponse :

{
  "message": "SUCCESS",
  "error": false,
  "data": [
    {
      "id": "uuid-1",
      "key": "sk_live_abc...",
      "isActive": true
    },
    {
      "id": "uuid-2",
      "key": "sk_live_def...",
      "isActive": false
    }
  ],
  "status": 200
}

Obtenir les détails d'une clé

Endpoint : GET /api-key/{id}

curl -X GET "https://admin.yodi.tg/api/api-key/key_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY"

Modifier le nom/paramètres d'une clé

Endpoint : PATCH /api-key/{id}

curl -X PATCH "https://admin.yodi.tg/api/api-key/key_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Key Name",
    "description": "Updated description"
  }'

Renouveler une clé API

Endpoint : POST /api-key/{id}/rotate

Génère une nouvelle clé tout en conservant le nom et les paramètres. L'ancienne clé devient invalide.

curl -X POST "https://admin.yodi.tg/api/api-key/key_abc123/rotate" \
  -H "Authorization: Bearer YOUR_API_KEY"

Réponse :

{
  "message": "KEY_ROTATED_SUCCESS",
  "error": false,
  "data": {
    "id": "uuid-1",
    "key": "sk_live_new_key_here",
    "isActive": true
  },
  "status": 200
}

Important

L'ancienne clé sera immédiatement révoquée. Mettez à jour tous les services utilisant l'ancienne clé dans les 5 minutes.

Révoquer une clé API

Endpoint : POST /api-key/{id}/revoke

Désactive définitivement une clé API. Cette action est irréversible.

curl -X POST "https://admin.yodi.tg/api/api-key/key_abc123/revoke" \
  -H "Authorization: Bearer YOUR_API_KEY"

Réponse :

{
  "message": "KEY_REVOKED_SUCCESS",
  "error": false,
  "data": {
    "id": "uuid-1",
    "isActive": false,
    "revokedAt": "2024-06-01T00:00:00.000Z"
  },
  "status": 200
}

danger

Révoquer une clé arrêtera immédiatement toutes les requêtes utilisant cette clé.

Supprimer une clé API

Endpoint : DELETE /api-key/{id}

curl -X DELETE "https://admin.yodi.tg/api/api-key/key_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY"

Réponse :

{
  "message": "SUCCESS",
  "error": false,
  "data": null,
  "status": 200
}

Bonnes pratiques de sécurité