​
Pagrindinis URL

Dabartinis REST API galinis taškas yra:

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

​
Antraštė

Siųskite savo API raktą X-API-Key antraštėje.

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

Create API key

​
Patikrinkite savo API raktą

Iškvieskite /me, kad patvirtintumėte raktą.

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

Jei raktas galioja, API grąžins jūsų naudotojo kontekstą, o ne autentifikavimo klaidą.

​
Autentifikavimo klaidos

Missing API key

Jei API raktas nepateiktas, API grąžina 401 Unauthorized.

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

Invalid API key

Jei API raktas negalioja, API grąžina 403 Forbidden.

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

​
Saugumo pastabos

Keep keys server-side

API raktai skirti užklausoms iš serverio pusės. Nenaudokite jų tiesiogiai naršyklės pusės kode.

Store keys securely

Laikykite API raktus aplinkos kintamuosiuose arba slaptažodžių/sektretų saugykloje.

Rotate exposed keys

Pakeiskite API raktą, jei jis atsiranda kliento kode, žurnaluose, ekrano nuotraukose ar viešuose saugyklose.

​
MCP autentifikavimas

MCP nenaudoja Ocoya API raktų. MCP klientai autentifikuojasi per OAuth ir paprašo naudotojo patvirtinti prieigą prie brand.

Žr. MCP diegimo instrukcijoms.