Authentifizierung - Ocoya API Docs

Base URL

Der aktuelle REST API-Endpunkt ist:

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

Sende deinen API-Schlüssel im X-API-Key-Header.

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

Rufe /me auf, um den Schlüssel zu verifizieren.

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

Wenn der Schlüssel gültig ist, antwortet die API mit deinem Benutzerkontext statt mit einem Authentifizierungsfehler.

Missing API key

Wenn kein API-Schlüssel übergeben wird, gibt die API 401 Unauthorized zurück.

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

Invalid API key

Wenn der API-Schlüssel ungültig ist, gibt die API 403 Forbidden zurück.

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

Keep keys server-side

API-Schlüssel sind für Backend-Anfragen gedacht. Verwende sie nicht direkt in Code, der im Browser läuft.

Store keys securely

Speichere API-Schlüssel in Umgebungsvariablen oder einem Secrets Manager.

Rotate exposed keys

Ersetze einen API-Schlüssel, wenn er in Client-Code, Logs, Screenshots oder öffentlichen Repositories auftaucht.

MCP verwendet keine Ocoya API-Schlüssel. MCP-Clients authentifizieren über OAuth und bitten den Benutzer, den Zugriff auf Brands zu genehmigen.

Sieh dir MCP für die Einrichtung an.