Un token API permette al tuo codice di parlare con Ocoya. Li trovi sotto Settings → API — Settings è nel menu dell’account, l’avatar in cima alla barra laterale.
Questa pagina spiega come gestire i token. Per come chiamare davvero l’API — la base URL, l’header, gli endpoint — vedi la documentazione REST API.
Inizia da qui. Il menu dell’account è l’avatar in cima alla barra laterale — Settings, poi API nella barra laterale delle impostazioni.
Settings → API, con il grafico delle richieste sopra e i tuoi token sotto.
Who can use the API
L’accesso all’API è riservato solo a owners and admins di un brand.
| Il tuo ruolo in un brand | Create tokens | Un token raggiunge il brand |
|---|---|---|
| Owner | Sì | Sì |
| Admin | Sì | Sì |
| Manager | No | No |
| Client | No | No |
Un manager che ha bisogno di accesso API per un brand deve essere reso admin di quel brand dall’owner (Settings → Members). Nell’app, l’opzione API viene mostrata in Settings solo agli owners e agli admins.
Create a token
Seleziona Create token e dagli un nome. Il nome è solo per te — serve per distinguere i token in seguito e revocare quello giusto.
Dai ai token il nome del posto in cui vengono usati, non di quello che fanno. Zapier, staging server, reporting script ti dicono cosa smette di funzionare quando li revochi. API key 2 no.
Copia il token non appena viene creato e conservalo in un posto sicuro. Dopo, Ocoya mostra solo i primi e gli ultimi caratteri.
What a token can reach
Un token è tuo, e raggiunge ogni brand di cui sei owner o admin. Un singolo token copre tutti, inclusi i brand di cui diventi admin in seguito. Non c’è modo di limitare un token a un singolo brand — nella lista dei token vedrai All brands accanto a ciascuno.
I brand a cui un token può accedere vengono controllati a ogni richiesta, in base al tuo ruolo in quel momento. Se vieni rimosso da un brand, o smetti di esserne admin, i tuoi token smettono subito di raggiungerlo; se diventi admin di un brand, lo raggiungono subito. Un token può fare tutto ciò che l’API offre in ogni brand a cui arriva.
Questo conta se stavi pensando di dare al developer di un cliente un token solo per il suo brand. Non puoi. Avrebbe accesso a tutti i brand a cui puoi accedere tu.
Un token funziona con tutto nella REST API: post, campagne AI (crearle, elencarle e leggerle con i relativi post), il profilo e il punteggio di ciascun brand, che può anche aggiornare, canali e workflow.
Revoke a token
Il menu ⋯ su qualsiasi token offre Delete token. L’eliminazione è immediata e permanente — qualsiasi cosa stia usando quel token inizia a fallire subito, quindi assicurati prima di sapere cosa lo sta usando. È per questo che servono i nomi.
Non c’è modo di ruotare un token mantenendo lo stesso. Per sostituirne uno: crea il nuovo token, sposta l’integrazione sul nuovo, poi elimina il vecchio.
Watching usage
Il grafico API usage mostra le richieste autenticate per il brand corrente, nell’ultima ora, giorno o 30 giorni. È il modo più rapido per confermare che un’integrazione stia davvero chiamando Ocoya, o per notarne una che chiama molto più del previsto.
Ocoya consente 60 requests per minute per chiave e restituisce 429 Too Many Requests oltre quel limite. Tutti i dettagli, incluse le intestazioni di rate-limit, sono in Rate limits.