API raktas leidžia jūsų pačių kodui kalbėtis su Ocoya. Juos rasite skiltyje Settings → API — Settings yra paskyros meniu, avataras šoninėje juostoje viršuje.
Šiame puslapyje aprašoma, kaip valdyti raktus. Kaip iš tikrųjų kviesti API — bazinis URL, antraštė, galiniai taškai — aprašyta REST API dokumentacijoje.
Pradėkite čia. Paskyros meniu yra avataras šoninėje juostoje viršuje — Settings, tada API nustatymų šoninėje juostoje.
Settings → API, viršuje užklausų diagrama, apačioje – jūsų raktai.
Who can use the API
API prieiga skirta tik prekės ženklo owners and admins.
| Your role in a brand | Create tokens | A token reaches the brand |
|---|---|---|
| Owner | Yes | Yes |
| Admin | Yes | Yes |
| Manager | No | No |
| Client | No | No |
Jei manager reikia API prieigos prekės ženklui, prekės ženklo savininkas turi jį padaryti administratoriumi (Settings → Members). Pačioje programoje API parinktis nustatymuose rodoma tik owners ir admins.
Create a token
Pasirinkite Create token ir suteikite jam pavadinimą. Pavadinimas skirtas tik jums — jis reikalingas tam, kad vėliau galėtumėte atskirti raktus ir panaikinti tinkamą.
Raktus vadinkite pagal tai, kur jie naudojami, o ne ką daro. Zapier, staging server, reporting script leidžia suprasti, kas nustos veikti, kai jį panaikinsite. API key 2 — ne.
Nukopijuokite raktą iškart po sukūrimo ir saugokite jį saugioje vietoje. Vėliau Ocoya rodo tik pirmus ir paskutinius kelis simbolius.
What a token can reach
Raktas yra jūsų ir pasiekia visus prekės ženklus, kuriuos jūs turite arba kurių esate administratorius. Vienas raktas apima juos visus, įskaitant prekės ženklus, kurių administratoriumi tapsite vėliau. Nėra būdo apriboti rakto iki vieno prekės ženklo — rakto sąraše prie kiekvieno matysite All brands.
Kokius prekės ženklus raktas pasiekia, tikrinama su kiekviena užklausa, pagal jūsų vaidmenį tuo momentu. Jei jus pašalina iš prekės ženklo arba nustojate būti jo administratorius, jūsų raktai iškart nustoja jį pasiekti; jei tampate prekės ženklo administratoriumi, jie jį pasiekia iškart. Raktas gali daryti viską, ką siūlo API, kiekviename prekės ženkle, kurį jis pasiekia.
Tai svarbu, jei planavote duoti kliento programuotojui raktą tik jo prekės ženklui. Negalite. Jis galės pasiekti visus prekės ženklus, kuriuos pasiekiate jūs.
Raktas veikia su viskuo REST API: įrašais, AI kampanijomis (jas kuria, išvardija ir nuskaito kartu su jų įrašais), kiekvieno prekės ženklo profiliu ir brand score, kuriuos taip pat gali atnaujinti, kanalais ir darbo sekų (workflows) funkcijomis.
Revoke a token
Bet kurio rakto meniu ⋯ siūlo Delete token. Panaikinimas yra momentinis ir neatšaukiamas — viskas, kas naudoja tą raktą, iškart pradeda veikti su klaidomis, tad prieš tai įsitikinkite, kad žinote, kas jį naudoja. Tam ir skirti pavadinimai.
Nėra būdo „sukamžinti“ raktą vietoje. Jei norite jį pakeisti: sukurkite naują raktą, perkelkite integraciją, tada ištrinkite senąjį.
Watching usage
Diagrama API usage rodo autentifikuotas užklausas esamam prekės ženklui per paskutinę valandą, dieną arba 30 dienų. Tai greičiausias būdas įsitikinti, kad integracija iš tikrųjų kviečia Ocoya, arba pastebėti, kad ji kviečia daug dažniau, nei tikėjotės.
Ocoya leidžia 60 užklausų per minutę vienam raktui ir grąžina 429 Too Many Requests, jei riba viršijama. Visą informaciją, įskaitant greičio ribojimo antraštes, rasite skiltyje Rate limits.