Začínáme s REST API

REST API Scratcheru umožňuje vašim vlastním systémům číst vaše kampaně, leady a seznamy, přidávat a aktualizovat leady a spravovat produkty. Tento článek je pro vývojáře, který API nastavuje. API je součástí tarifu Basic a vyšších.

Vytvoření přístupového tokenu

1. Přejděte do Nastavení > API (pod Vývojáři).
2. V části Osobní přístupové tokeny klikněte na Vytvořit osobní přístupový token.
3. Zadejte Název, například „Datový sklad“, a zvolte Oprávnění, která token potřebuje. Dejte mu jen ten přístup, který opravdu potřebuje.
4. Klikněte na Uložit a zkopírujte token pod Tajný klíč. Uvidíte ho jen jednou, proto ho bezpečně uložte, například ve správci hesel.

Token patří vašemu uživateli a má přístup ke všem účtům, jejichž jste členem. Pokud chcete přístup odebrat, otevřete token a klikněte na Odvolat.

Oprávnění (scopes)

• read:campaigns: čtení kampaní
• read:lists: čtení seznamů leadů
• read:leads a write:leads: čtení, vytváření, aktualizace a mazání leadů
• read:placements a write:placements: čtení a správa umístění
• read:products a write:products: čtení a správa produktů

Odeslání požadavku

Základní URL je https://platform.scratcher.io/api/v1/. Token posílejte v hlavičce Authorization:

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

Hlavní endpointy

• GET /me: uživatel, kterému token patří
• GET /accounts: účty, ke kterým máte přístup
• GET /accounts/{account}/campaigns a /campaigns/{campaign}: vaše kampaně
• GET /accounts/{account}/campaigns/{campaign}/leads: leady kampaně s výhrami, kódy a udělenými souhlasy
• GET /accounts/{account}/lists a /lists/{list}/leads: seznamy leadů a jejich leady, plus POST, PUT a DELETE pro správu leadů
• /accounts/{account}/products: produkty
• /accounts/{account}/placements: umístění

Výsledky jsou stránkované pomocí ?page=. Limit je 60 požadavků za minutu na uživatele.

Kompletní referenci s příklady a kolekcí pro Postman najdete v referenční dokumentaci API. Odkazuje na ni i tlačítko Reference API v platformě.

OAuth aplikace

Pokud vytváříte aplikaci, ke které se připojují další uživatelé Scratcheru, zaregistrujte ji v Moje aplikace > Vytvořit aplikaci s údaji Název aplikace a URI pro přesměrování. Dostanete ID klienta a Tajný klíč klienta. Tajný klíč se zobrazí jen jednou. Aplikace, které lidé schválili, jsou uvedené v Autorizované aplikace, kde je lze odvolat.