Kom i gang med REST API-et

Med Scratchers REST API kan dine egne systemer lese kampanjene, leadsene og listene dine, legge til og oppdatere leads og administrere produkter. Denne artikkelen er for utvikleren som setter det opp. API-et er en del av Basic-planen og oppover.

Opprett et tilgangstoken

1. Gå til Innstillinger > API (under Utviklere).
2. Under Personlige tilgangstokener klikker du på Opprett personlig tilgangstoken.
3. Gi det et Navn, for eksempel «Datavarehus», og velg hvilket Tilgangsomfang det trenger. Gi det bare den tilgangen det trenger.
4. Klikk på Lagre og kopier tokenet under Hemmelighet. Du ser det bare én gang, så oppbevar det trygt, for eksempel i en passordbehandler.

Et token hører til brukeren din og når alle kontoer du er medlem av. For å fjerne tilgangen åpner du tokenet og klikker på Tilbakekall.

Tilgangsomfang

• read:campaigns: les kampanjer
• read:lists: les leadlister
• read:leads og write:leads: les, opprett, oppdater og slett leads
• read:placements og write:placements: les og administrer plasseringer
• read:products og write:products: les og administrer produkter

Send en forespørsel

Basis-URL-en er https://platform.scratcher.io/api/v1/. Send tokenet i Authorization-headeren:

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

De viktigste endepunktene

• GET /me: brukeren som tokenet hører til
• GET /accounts: kontoene du har tilgang til
• GET /accounts/{account}/campaigns og /campaigns/{campaign}: kampanjene dine
• GET /accounts/{account}/campaigns/{campaign}/leads: leadsene i en kampanje, med premier, koder og godkjente samtykker
• GET /accounts/{account}/lists og /lists/{list}/leads: leadlister og leadsene i dem, pluss POST, PUT og DELETE for å administrere leads
• /accounts/{account}/products: produkter
• /accounts/{account}/placements: plasseringer

Resultatene deles opp i sider med ?page=. Grensen er 60 forespørsler per minutt per bruker.

Den fullstendige referansen, med eksempler og en Postman-samling, finner du i API-referansedokumentasjonen. Knappen API-referanse i plattformen lenker også dit.

OAuth-apper

Bygger du en app som andre Scratcher-brukere kobler seg til, registrerer du den under Mine apper > Opprett app med et Applikasjonsnavn og en Videresendings-URI. Du får en Klient-ID og en Klienthemmelighet. Hemmeligheten vises bare én gang. Apper som folk har godkjent, står under Autoriserte apper, der tilgangen kan tilbakekalles.