Primii pași cu REST API

REST API-ul Scratcher le permite propriilor sisteme să citească campaniile, lead-urile și listele, să adauge și să actualizeze lead-uri și să gestioneze produse. Acest articol se adresează dezvoltatorului care face configurarea. API-ul este inclus începând cu planul Basic.

Creați un token de acces

1. Mergeți la Setări > API (sub Dezvoltatori).
2. Sub Tokenuri de acces personal, faceți clic pe Creați token de acces personal.
3. Dați-i un Nume, de exemplu „Data warehouse”, și alegeți Permisiuni (scopes) de care are nevoie. Dați-i doar accesul de care are nevoie.
4. Faceți clic pe Salvați și copiați tokenul de sub Secret. Îl vedeți o singură dată, așa că păstrați-l în siguranță, de exemplu într-un manager de parole.

Un token aparține utilizatorului dumneavoastră și are acces la fiecare cont în care sunteți membru. Pentru a elimina accesul, deschideți tokenul și faceți clic pe Revocați.

Permisiuni (scopes)

• read:campaigns: citirea campaniilor
• read:lists: citirea listelor de lead-uri
• read:leads și write:leads: citirea, crearea, actualizarea și ștergerea lead-urilor
• read:placements și write:placements: citirea și gestionarea plasărilor
• read:products și write:products: citirea și gestionarea produselor

Faceți o cerere

URL-ul de bază este https://platform.scratcher.io/api/v1/. Trimiteți tokenul în headerul Authorization:

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

Endpointuri principale

• GET /me: utilizatorul căruia îi aparține tokenul
• GET /accounts: conturile la care aveți acces
• GET /accounts/{account}/campaigns și /campaigns/{campaign}: campaniile dumneavoastră
• GET /accounts/{account}/campaigns/{campaign}/leads: lead-urile unei campanii, cu premii, coduri și consimțăminte acordate
• GET /accounts/{account}/lists și /lists/{list}/leads: listele de lead-uri și lead-urile lor, plus POST, PUT și DELETE pentru gestionarea lead-urilor
• /accounts/{account}/products: produse
• /accounts/{account}/placements: plasări

Rezultatele sunt paginate cu ?page=. Limita este de 60 de cereri pe minut per utilizator.

Referința completă, cu exemple și o colecție Postman, se află în documentația de referință API. Butonul Referință API din platformă are și el link către ea.

Aplicații OAuth

Dacă construiți o aplicație la care se conectează alți utilizatori Scratcher, înregistrați-o sub Aplicațiile mele > Creați aplicație, cu Numele aplicației și URI de redirecționare. Primiți un ID client și un Client secret. Secretul este afișat o singură dată. Aplicațiile aprobate de utilizatori apar sub Aplicații autorizate, unde pot fi revocate.