Base URL

Aktualny endpoint REST API to:

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

Przekaż swój klucz API w nagłówku X-API-Key.

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

Create API key

Test Your API Key

Wywołaj /me, żeby sprawdzić swój klucz.

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

Jeśli klucz jest poprawny, API zwróci twój kontekst użytkownika zamiast błędu uwierzytelniania.

Authentication Errors

Missing API key

Jeśli klucz API nie zostanie podany, API zwróci 401 Unauthorized.

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

Invalid API key

Jeśli klucz API jest nieprawidłowy, API zwróci 403 Forbidden.

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

Security Notes

Keep keys server-side

Klucze API są przeznaczone do zapytań z backendu. Nie używaj ich bezpośrednio w kodzie po stronie przeglądarki.

Store keys securely

Przechowuj klucze API w zmiennych środowiskowych lub w menedżerze sekretów.

Rotate exposed keys

Wymień klucz API, jeśli pojawi się w kodzie klienta, logach, zrzutach ekranu lub publicznych repozytoriach.

MCP Authentication

MCP nie używa kluczy API Ocoya. Klienci MCP uwierzytelniają się przez OAuth i proszą użytkownika o zatwierdzenie dostępu do brandu.

Zobacz MCP, żeby poznać instrukcje konfiguracji.