Inizia con la REST API

La REST API di Scratcher permette ai tuoi sistemi di leggere le tue campagne, i lead e le liste, aggiungere e aggiornare lead e gestire i prodotti. Questo articolo è per lo sviluppatore che la configura. L'API è inclusa dal piano Basic in su.

Crea un token di accesso

1. Vai su Impostazioni > API (sotto Sviluppatori).
2. In Token di accesso personali, clicca su Crea token di accesso personale.
3. Dagli un Nome, come "Data warehouse", e scegli gli Ambiti di cui ha bisogno. Dagli solo l'accesso che gli serve.
4. Clicca su Salva e copia il token sotto Secret. Lo vedi una sola volta, quindi conservalo in un posto sicuro, per esempio in un password manager.

Un token appartiene al tuo utente e può raggiungere tutti gli account di cui sei membro. Per rimuovere l'accesso, apri il token e clicca su Revoca.

Ambiti

• read:campaigns: leggere le campagne
• read:lists: leggere le liste di lead
• read:leads e write:leads: leggere, creare, aggiornare ed eliminare lead
• read:placements e write:placements: leggere e gestire i posizionamenti
• read:products e write:products: leggere e gestire i prodotti

Fai una richiesta

L'URL di base è https://platform.scratcher.io/api/v1/. Invia il token nell'header Authorization:

curl https://platform.scratcher.io/api/v1/accounts \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Accept: application/json" 

Endpoint principali

• GET /me: l'utente a cui appartiene il token
• GET /accounts: gli account a cui hai accesso
• GET /accounts/{account}/campaigns e /campaigns/{campaign}: le tue campagne
• GET /accounts/{account}/campaigns/{campaign}/leads: i lead di una campagna, con premi, codici e consensi accettati
• GET /accounts/{account}/lists e /lists/{list}/leads: le liste di lead e i loro lead, più POST, PUT e DELETE per gestire i lead
• /accounts/{account}/products: i prodotti
• /accounts/{account}/placements: i posizionamenti

I risultati sono paginati con ?page=. Il limite è di 60 richieste al minuto per utente.

Il riferimento completo, con esempi e una collection Postman, si trova nella documentazione di riferimento dell'API. Anche il pulsante Riferimento API nella piattaforma porta lì.

App OAuth

Se crei un'app a cui si collegano altri utenti Scratcher, registrala in Le mie app > Crea app con un Nome dell’applicazione e un URI di reindirizzamento. Ricevi un ID client e un Client secret. Il secret viene mostrato una sola volta. Le app approvate dalle persone sono elencate in App autorizzate, dove si possono revocare.