Base URL

El endpoint actual de la REST API es:

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

Envía tu API key en el header X-API-Key.

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

Create API key

Test Your API Key

Llama a /me para verificar la key.

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

Si la key es válida, la API responde con tu contexto de usuario en lugar de un error de autenticación.

Authentication Errors

Missing API key

Si no se proporciona ninguna API key, la API devuelve 401 Unauthorized.

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

Invalid API key

Si la API key no es válida, la API devuelve 403 Forbidden.

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

Security Notes

Keep keys server-side

Las API keys están pensadas para peticiones desde el backend. No las uses directamente en código del navegador.

Store keys securely

Almacena las API keys en variables de entorno o en un gestor de secretos.

Rotate exposed keys

Sustituye una API key si aparece en código cliente, logs, capturas de pantalla o repositorios públicos.

MCP Authentication

MCP no usa Ocoya API keys. Los clientes MCP se autentican mediante OAuth y piden al usuario que apruebe el acceso a la brand.

Consulta MCP para ver las instrucciones de configuración.