Kom igång med REST API:t

Med Scratchers REST API kan dina egna system läsa dina kampanjer, leads och listor, lägga till och uppdatera leads och hantera produkter. Den här artikeln är till för utvecklaren som sätter upp det. API:t ingår från Basic-planen och uppåt.

Skapa en åtkomsttoken

1. Gå till Inställningar > API (under Utvecklare).
2. Under Personliga åtkomsttokens klickar du på Skapa personlig åtkomsttoken.
3. Ge den ett Namn, till exempel "Datalager", och välj de Behörigheter den behöver. Ge den bara den åtkomst den behöver.
4. Klicka på Spara och kopiera token under Hemlighet. Du ser den bara en gång, så förvara den säkert, till exempel i en lösenordshanterare.

En token tillhör din användare och når alla konton som du är medlem i. Om du vill ta bort åtkomsten öppnar du token och klickar på Återkalla.

Behörigheter

• read:campaigns: läsa kampanjer
• read:lists: läsa leadlistor
• read:leads och write:leads: läsa, skapa, uppdatera och radera leads
• read:placements och write:placements: läsa och hantera placeringar
• read:products och write:products: läsa och hantera produkter

Gör en förfrågan

Bas-URL:en är https://platform.scratcher.io/api/v1/. Skicka token i headern Authorization:

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

De viktigaste endpoints

• GET /me: användaren som token tillhör
• GET /accounts: kontona som du har åtkomst till
• GET /accounts/{account}/campaigns och /campaigns/{campaign}: dina kampanjer
• GET /accounts/{account}/campaigns/{campaign}/leads: leads för en kampanj, med vinster, koder och godkända samtycken
• GET /accounts/{account}/lists och /lists/{list}/leads: leadlistor och deras leads, plus POST, PUT och DELETE för att hantera leads
• /accounts/{account}/products: produkter
• /accounts/{account}/placements: placeringar

Resultaten delas upp i sidor med ?page=. Gränsen är 60 förfrågningar per minut och användare.

Den fullständiga referensen, med exempel och en Postman-samling, finns i API-referensdokumentationen. Knappen API-referens i plattformen länkar också dit.

OAuth-appar

Om du bygger en app som andra Scratcher-användare ansluter till registrerar du den under Mina appar > Skapa app med Applikationens namn och Omdirigerings-URI. Du får ett Klient-ID och en Klienthemlighet. Hemligheten visas bara en gång. Appar som användare har godkänt listas under Auktoriserade appar, där åtkomsten kan återkallas.