Token API pozwala twojemu własnemu kodowi rozmawiać z Ocoya. Znajdziesz je w Settings → API — Settings jest w menu konta, pod avatarem na górze paska bocznego.
Na tej stronie chodzi o zarządzanie tokenami. Jeśli chcesz wiedzieć, jak faktycznie wywoływać API — base URL, nagłówki, endpointy — zajrzyj do REST API documentation.
Zacznij tutaj. Menu konta to avatar na górze paska bocznego — Settings, potem API w bocznym pasku ustawień.
Settings → API, z wykresem zapytań u góry i twoimi tokenami poniżej.
Who can use the API
Dostęp do API mają tylko owners and admins danego brandu.
| Your role in a brand | Create tokens | A token reaches the brand |
|---|---|---|
| Owner | Yes | Yes |
| Admin | Yes | Yes |
| Manager | No | No |
| Client | No | No |
Manager, który potrzebuje dostępu do API dla brandu, musi zostać ustawiony jako admin przez ownera brandu (Settings → Members). W aplikacji opcja API w Settings jest pokazywana tylko ownerom i adminom.
Create a token
Wybierz Create token i nadaj mu nazwę. Nazwa jest tylko dla ciebie — po to, żebyś później mógł/mogła odróżnić tokeny i cofnąć właściwy.
Nazywaj tokeny od miejsca, w którym są używane, a nie od tego, co robią. Zapier, staging server, reporting script mówi ci, co przestanie działać, kiedy go cofniesz. API key 2 tego nie robi.
Skopiuj token od razu po utworzeniu i zapisz go w bezpiecznym miejscu. Później Ocoya pokazuje tylko kilka pierwszych i ostatnich znaków.
What a token can reach
A token is yours, and reaches every brand you own or are an admin of. Jeden token obejmuje je wszystkie, w tym brandy, do których zostaniesz adminem później. Nie ma sposobu, żeby zawęzić token do jednego brandu — na liście tokenów przy każdym widnieje All brands.
To, do jakich brandów token ma dostęp, jest sprawdzane przy każdym żądaniu, na podstawie twojej roli w danym momencie. Jeśli zostaniesz usunięty/a z brandu albo przestaniesz być jego adminem, twoje tokeny natychmiast tracą do niego dostęp; jeśli zostaniesz adminem brandu, natychmiast go zyskują. Token może robić w każdym brandzie, do którego ma dostęp, wszystko to, co oferuje API.
To ma znaczenie, jeśli planowałeś/plnowałaś dać developerowi klienta token tylko do jego brandu. Nie możesz. Miałby dostęp do wszystkich brandów, do których ty masz dostęp.
Token działa ze wszystkim, co jest w REST API: postami, kampaniami AI (tworzenie ich, listowanie i odczytywanie razem z ich postami), profilem każdego brandu i brand score, które może też aktualizować, kanałami i workflowami.
Revoke a token
Menu ⋯ przy dowolnym tokenie ma opcję Delete token. Usunięcie jest natychmiastowe i trwałe — cokolwiek używa tego tokena, zacznie od razu zawodzić, więc upewnij się najpierw, co z niego korzysta. Po to są nazwy.
Nie ma sposobu, żeby obrócić (zrotować) token w miejscu. Żeby wymienić token: utwórz nowy, przełącz na niego swoją integrację, a potem usuń stary.
Watching usage
Wykres API usage pokazuje uwierzytelnione żądania dla bieżącego brandu z ostatniej godziny, dnia lub 30 dni. To najszybszy sposób, żeby potwierdzić, że integracja faktycznie wywołuje Ocoya, albo zauważyć, że wywołuje ją dużo częściej, niż się spodziewałeś/spodziewałaś.
Ocoya pozwala na 60 requests per minute na klucz i zwraca 429 Too Many Requests powyżej tego limitu. Pełne szczegóły, w tym nagłówki limitów zapytań, znajdziesz w Rate limits.