API žetonas leidžia jūsų kodui bendrauti su Ocoya. Rasite juos skiltyje Settings → API. Settings yra paskyros meniu, t. y. avatare šoninės juostos viršuje.
Šiame puslapyje aprašyta, kaip valdyti žetonus. Kaip iš tikrųjų kreiptis į API (bazinis URL, antraštė, galiniai taškai), skaitykite REST API dokumentacijoje.
Pradėkite čia. Paskyros meniu yra avataras šoninės juostos viršuje: pasirinkite Settings, tada nustatymų šoninėje juostoje – API.
Settings → API: viršuje užklausų diagrama, žemiau – jūsų žetonai.
Žetono sukūrimas
Spustelėkite Create token ir pavadinkite žetoną. Pavadinimas skirtas tik jums: pagal jį vėliau atskirsite žetonus ir atšauksite tinkamą.
Žetonus vadinkite pagal tai, kur jie naudojami, o ne ką jie daro. Pavadinimai Zapier, staging server, reporting script parodo, kas sustos, kai atšauksite žetoną. Pavadinimas API key 2 to nepasako.
Nukopijuokite žetoną iškart, kai jis sukuriamas, ir saugokite jį patikimoje vietoje. Vėliau Ocoya rodo tik pirmuosius ir paskutinius kelis simbolius.
Ką žetonas pasiekia
Kiekvienas žetonas pasiekia visus šios paskyros prekių ženklus (brands). Žetono apriboti vienu prekės ženklu neįmanoma: žetonų sąraše prie kiekvieno rodoma All brands.
Tai svarbu, jei planavote duoti kliento programuotojui žetoną tik jo prekės ženklui. To padaryti negalima. Jis galėtų pasiekti visus jūsų prekių ženklus.
Žetono atšaukimas
Bet kurio žetono meniu ⋯ yra Delete token. Ištrynimas įsigalioja iškart ir yra negrįžtamas: viskas, kas naudoja tą žetoną, tuoj pat nustoja veikti, todėl pirmiausia įsitikinkite, kas jį naudoja. Būtent tam ir skirti pavadinimai.
Žetono pakeisti vietoje negalima. Norėdami jį pakeisti, sukurkite naują žetoną, perkelkite integraciją prie jo, tada ištrinkite seną.
Naudojimo stebėjimas
Diagrama API usage rodo autentifikuotas dabartinio prekės ženklo užklausas per paskutinę valandą, dieną arba 30 dienų. Tai greičiausias būdas patikrinti, ar integracija tikrai kreipiasi į Ocoya, arba pastebėti tokią, kuri kreipiasi daug dažniau, nei tikėjotės.
Ocoya leidžia 60 užklausų per minutę vienam raktui, o viršijus šią ribą grąžina 429 Too Many Requests. Visa informacija, įskaitant ribojimo antraštes, pateikta skyriuje Rate limits.