Ocoya
API

Įdiekite socialinių tinklų publikavimą į savo produktą.

Aiški REST API su paskelbta OpenAPI specifikacija leidžia įdiegti DI valdomą socialinių tinklų publikavimą į bet kurią jūsų kuriamą programėlę, darbo eigą ar agentą.

POST /v1/post
curl -X POST https://app.ocoya.com/api/_public/v1/post \
-H "X-API-Key: $OCOYA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"socialProfileIds": ["sp_8f2a1c"],
"caption": "New summer menu is here ☀️",
"media": ["https://cdn.example.com/summer.jpg"],
"scheduledAt": "2026-09-01T09:00:00Z"
}'
201 Created
{
"id": "post_8f2a1c",
"status": "SCHEDULED",
"scheduledAt": "2026-09-01T09:00:00Z"
}

Aiški REST + OpenAPI

Nuspėjami REST ištekliai su paskelbta OpenAPI specifikacija – sugeneruokite klientą bet kuria kalba.

Autentifikacija API raktu

Siųskite X-API-Key antraštę – kurkite ir atšaukite raktus kiekvienam prekės ženklui nustatymuose.

DI įskaičiuotas

Tas pats DI įrašų ir kampanijų generavimas, kurį naudoja programėlė, iškviečiamas iš jūsų serverio.

Tas pats variklis kaip programėlėje

Kiekvienas galinis taškas atkartoja tai, kas veikia pačioje Ocoya – nieko nenuslėpta.

OpenAPI

Specifikacija, iš kurios galima sugeneruoti klientą.

Visa v1 sąsaja pateikiama kaip OpenAPI dokumentas, todėl nereikia skaityti aprašymų ir rankomis rašyti užklausų objektų. Sugeneruokite tipizuotą klientą ta kalba, kuria jau dirbate, arba nukreipkite į ją Postman, Insomnia ar savo įrankius.

  • Tipizuoti klientai bet kuria generatorių palaikoma kalba
  • Užklausų ir atsakymų struktūros sutampa su API
  • Įdėkite į esamus API įrankius be pakeitimų
openapi.jsonv1
{
"openapi": "3.1.0",
"paths": {
"/v1/post": { ... },
"/v1/campaigns": { ... }
}
}
TypeScriptPythonGoRubyPHPJava

Sugeneruokite tipizuotą klientą ta kalba, kuria jau rašote, arba nukreipkite savo API įrankius tiesiai į specifikaciją.

Asinchroniškai

Ilgi darbai grįžta iš karto.

DI kampanijų generavimas įtraukiamas į eilę, o ne vykdomas jūsų užklausos metu. Užklausa iš karto grąžina kampanijos id; tikrinkite išteklių, ir įrašai užsipildys, kai bus parašyti, todėl niekas jūsų programėlėje nelaukia modelio.

  • Kampanijos kūrimas iš karto atsako su id
  • Tikrinkite kampanijos išteklių ir stebėkite, kaip atsiranda įrašai
  • DI generavimas naudoja tuos pačius kreditus kaip programėlė
POST /v1/campaignsgenerating
// returns immediately
{ "id": "cmp_8fa2", "status": "generating", "posts": 8 }
Įrašas 1 – Instagram
Įrašas 2 – LinkedIn
Įrašas 3 – X
Įrašas 4 – Instagram
Įrašas 5 – TikTok

Užklausa grįžta iš karto. Tikrinkite kampanijos išteklių, ir įrašai atsiras, kai tik bus sugeneruoti – niekas neblokuoja jūsų užklausos gijos.

Ištekliai

Viskas, ką gali programėlė, iškviečiama tiesiogiai.

Aštuoni REST ištekliai apima visą platformą – publikavimą, DI kampanijas, prekės ženklo išteklius, darbo eigas ir prekės ženklus.

/v1/post

Kurkite, planuokite, atnaujinkite ir publikuokite įrašus prijungtuose tinkluose.

/v1/campaigns

Įtraukite DI kampanijų generavimą į eilę ir stebėkite, kaip pildosi įrašai.

/v1/social-profiles

Peržiūrėkite prijungtus profilius ir pradėkite naujus prijungimus.

/v1/hashtag-libraries

Gaukite atrinktus grotažymių rinkinius ir prijunkite juos prie įrašų programiškai.

/v1/studio-templates

Peržiūrėkite daugkartinius Studio dizaino šablonus naujam turiniui.

/v1/workflow

Peržiūrėkite, įjunkite ir paleiskite automatizavimo darbo eigas pagal poreikį.

/v1/brands

Išvardykite prekės ženklus ir teisingai apibrėžkite kiekvienos užklausos sritį.

/v1/me

Patikrinkite raktą – kas aš ir ką galiu pasiekti?

Įrašo gyvavimo ciklas

Visada žinote, kur yra įrašas.

Kiekvienas įrašas turi vieną iš aštuonių būsenų, ir galite filtruoti pagal bet kurią. Tikrinkite kampaniją, kol ji generuojama, sulaikykite įrašus iki patvirtinimo arba įspėkite savo sistemas, kai tik kam nors prireikia žmogaus.

Klaidos niekada nedingsta tyliai – NEEDS_ATTENTION ir ERROR turi tinklo nurodytą priežastį, todėl galite ją parodyti savo sąsajoje.

GET /v1/post?statuses=

8 reikšmės
GENERATING
DRAFT
PENDING_INTERNAL_APPROVAL
PENDING_CLIENT_APPROVAL
SCHEDULED
POSTED
NEEDS_ATTENTION
ERROR

Užklausos šiame lange

60s

RateLimit-Limit

60

RateLimit-Remaining

17

RateLimit-Reset

38

429 Too Many Requests
{
"message": "You've exceeded the request limit."
}
Limitai

Nuspėjami limitai, standartinės antraštės.

Pagal numatymą – 60 užklausų per minutę. Kiekviename atsakyme yra standartinės RateLimit-* antraštės, todėl jūsų klientas gali sulėtinti tempą dar prieš gaudamas 429 – jokių spėlionių, jokio nedokumentuoto ribojimo.

Likusį limitą matote kiekviename atsakyme429 tiksliai nurodo, kada bandyti dar kartąMasinis publikavimas vyksta serveryje, o ne užklausa po užklausos
Prijungimas

Leiskite naudotojams prijungti savo paskyras.

Paprašykite prijungimo URL ir perduokite jį naudotojui. Jis patvirtina pačiame tinkle, o profilis atsiranda jūsų prekės ženkle, paruoštas publikavimui – jūs niekada neliečiate socialinio tinklo rakto, o naudotojas niekada nemato Ocoya.

Būtent tai daro API tinkamą produktui, turinčiam savų klientų, o ne tik savos paskyros automatizavimui.

1Jūsų programėlėPOST /v1/social-profiles/connection-url
2OcoyaGrąžina vienkartinį OAuth pradžios URL
3Jūsų naudotojasPatvirtina Instagram, X, LinkedIn…
4Jūsų programėlėProfilis atsiranda /v1/social-profiles

Jūsų naudotojai niekada nemato Ocoya prisijungimo – ryšys atsiranda jūsų prekės ženkle.

Kuriate DI agentą?

Ta pati platforma pasiekiama per MCP – daugiau nei 20 įrankių, kuriuos jūsų agentas gali iškviesti tiesiogiai, be REST jungiamojo kodo.

Susipažinkite su MCP
Klausimai

Atsakymai apie API.

Sukurkite API raktą skiltyje Settings → API ir siųskite jį X-API-Key antraštėje į bazinį URL https://app.ocoya.com/api/_public/v1. Raktai priskirti prekės ženklui ir gali būti bet kada atšaukti – laikykite juos serveryje.

Pradėkite diegti socialinių tinklų publikavimą.

Gaukite API raktą ir atlikite pirmąją užklausą per kelias minutes.