Pierwsze kroki z REST API

REST API Scratchera pozwala twoim własnym systemom odczytywać kampanie, leady i listy, dodawać i aktualizować leady oraz zarządzać produktami. Ten artykuł jest dla dewelopera, który przeprowadza konfigurację. API jest dostępne od planu Basic wzwyż.

Utwórz token dostępu

1. Przejdź do Ustawienia > API (w sekcji Deweloperzy).
2. W sekcji Osobiste tokeny dostępu kliknij Utwórz osobisty token dostępu.
3. Nadaj mu Nazwa, np. „Hurtownia danych”, i wybierz potrzebne Zakresy uprawnień. Daj mu tylko taki dostęp, jakiego potrzebuje.
4. Kliknij Zapisz i skopiuj token w polu Sekret. Zobaczysz go tylko raz, więc przechowuj go bezpiecznie, np. w menedżerze haseł.

Token należy do twojego użytkownika i ma dostęp do każdego konta, którego jesteś członkiem. Aby odebrać dostęp, otwórz token i kliknij Odwołaj.

Zakresy uprawnień

• read:campaigns: odczyt kampanii
• read:lists: odczyt list leadów
• read:leads i write:leads: odczyt, tworzenie, aktualizacja i usuwanie leadów
• read:placements i write:placements: odczyt i zarządzanie miejscami wyświetlania
• read:products i write:products: odczyt i zarządzanie produktami

Wyślij żądanie

Bazowy URL to https://platform.scratcher.io/api/v1/. Wyślij token w nagłówku Authorization:

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

Najważniejsze endpointy

• GET /me: użytkownik, do którego należy token
• GET /accounts: konta, do których masz dostęp
• GET /accounts/{account}/campaigns i /campaigns/{campaign}: twoje kampanie
• GET /accounts/{account}/campaigns/{campaign}/leads: leady kampanii wraz z nagrodami, kodami i udzielonymi zgodami
• GET /accounts/{account}/lists i /lists/{list}/leads: listy leadów i ich leady, a także POST, PUT i DELETE do zarządzania leadami
• /accounts/{account}/products: produkty
• /accounts/{account}/placements: miejsca wyświetlania

Wyniki są stronicowane za pomocą ?page=. Limit wynosi 60 żądań na minutę na użytkownika.

Pełna dokumentacja z przykładami i kolekcją Postman znajduje się w dokumentacji API. Prowadzi do niej także przycisk Dokumentacja API na platformie.

Aplikacje OAuth

Jeśli tworzysz aplikację, z którą łączą się inni użytkownicy Scratchera, zarejestruj ją w Moje aplikacje > Utwórz aplikację, podając Nazwa aplikacji i URI przekierowania. Otrzymasz Client ID i Client Secret. Sekret jest wyświetlany tylko raz. Aplikacje zatwierdzone przez użytkowników są wymienione w sekcji Autoryzowane aplikacje, gdzie można odwołać ich dostęp.