Autenticação - Ocoya API Docs

Base URL

O endpoint atual da REST API é:

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

Envie a sua chave de API no header X-API-Key.

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

Chame /me para verificar a chave.

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

Se a chave for válida, a API responde com o seu contexto de utilizador em vez de um erro de autenticação.

Missing API key

Se não for fornecida nenhuma chave de API, a API devolve 401 Unauthorized.

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

Invalid API key

Se a chave de API for inválida, a API devolve 403 Forbidden.

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

Keep keys server-side

As chaves de API são concebidas para pedidos feitos a partir do backend. Não as utilize diretamente em código que corre no browser.

Store keys securely

Guarde as chaves de API em variáveis de ambiente ou num gestor de segredos.

Rotate exposed keys

Substitua uma chave de API se esta aparecer em código cliente, logs, capturas de ecrã ou repositórios públicos.

O MCP não utiliza chaves de API da Ocoya. Os clientes MCP autenticam-se através de OAuth e pedem ao utilizador para aprovar o acesso à marca.

Veja MCP para instruções de configuração.