Base URL

L’endpoint actuel de l’API REST est :

https://www.app.ocoya.com/api/_public/v1

Envoyez votre clé d’API dans le header X-API-Key.

X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: application/json

Create API key

Tester votre clé d’API

Appelez /me pour vérifier la clé.

curl -X GET "https://www.app.ocoya.com/api/_public/v1/me" \
  -H "X-API-Key: YOUR_API_KEY"

Si la clé est valide, l’API renvoie votre contexte utilisateur au lieu d’une erreur d’authentification.

Erreurs d’authentification

Missing API key

Si aucune clé d’API n’est fournie, l’API renvoie 401 Unauthorized.

{
  "message": "Missing API token."
}

Invalid API key

Si la clé d’API est invalide, l’API renvoie 403 Forbidden.

{
  "message": "Invalid API token."
}

Notes de sécurité

Keep keys server-side

Les clés d’API sont conçues pour les requêtes côté backend. Ne les utilisez pas directement dans du code exécuté côté navigateur.

Store keys securely

Stockez les clés d’API dans des variables d’environnement ou un gestionnaire de secrets.

Rotate exposed keys

Remplacez une clé d’API si elle apparaît dans du code client, des logs, des captures d’écran ou des dépôts publics.

Authentification MCP

MCP n’utilise pas les clés d’API Ocoya. Les clients MCP s’authentifient via OAuth et demandent à l’utilisateur d’approuver l’accès à la brand.

Voir MCP pour les instructions de configuration.