Preskoči na sadržaj
Rex, vaš AI asistent: rutinu preuzima on, ideje su vaše 👉 Upoznajte Rexa

Prvi koraci s REST API-jem

Izradite osobni pristupni token s odgovarajućim opsezima ili registrirajte OAuth aplikaciju te čitajte kampanje, leadove i popise iz vlastitih sustava.

Scratcher REST API omogućuje vašim sustavima da čitaju vaše kampanje, leadove i popise, dodaju i ažuriraju leadove te upravljaju proizvodima i položajima. Ovaj je članak namijenjen developeru koji ga postavlja.

API je dio paketa koji uključuju Webhooks & API (Basic i viši). Na ostalim paketima gumbi za izradu tokena i aplikacija su zaključani.

Izradite osobni pristupni token

Osobni pristupni token najbrži je način za pozivanje API-ja iz vlastitih skripti i sustava.

  1. Idite na Settings > API (pod Developers).
  2. Pod Personal access tokens kliknite Create personal access token. U dijaloškom okviru piše „Generate a token to authenticate API requests.”
  3. Dodijelite mu Name po kojem ćete ga kasnije prepoznati, npr. „Data warehouse”.
  4. Pod Scopes odaberite što token smije raditi (vidi niže). Select all odabire sve opsege. Tokenu dajte samo onaj pristup koji mu je potreban.
  5. Kliknite Save. Prikazat će se poruka „Your access token has been created”.
  6. Kopirajte token pod Secret. „Save the secret above, as this is the only time you will see it.” Pohranite ga na sigurno mjesto, primjerice u upravitelj lozinki.
  7. Kliknite Close.

Token pripada vašem korisniku. Može pristupiti svakom Scratcher računu čiji ste član, uz opsege koje ste odabrali.

Opsezi

  • read:campaigns (View campaigns): popis i čitanje kampanja
  • read:lists (View lists): popis i čitanje popisa leadova
  • read:leads (View leads): čitanje leadova
  • write:leads (Write leads): izrada, ažuriranje i brisanje leadova na popisu
  • read:placements (View placements): čitanje položaja
  • write:placements (Write placements): izrada, ažuriranje i brisanje položaja
  • read:products (View products): čitanje proizvoda
  • write:products (Write products): izrada, ažuriranje i brisanje proizvoda

Za čitanje leadova kampanje token treba i read:campaigns i read:leads. Za izradu i izmjenu položaja vaš paket mora uključivati i Embed / URL.

Opozovite token

Kliknite token na popisu kako biste otvorili Show personal access token. Prikazuju se Name i Scopes. Kliknite Revoke i potvrdite („Are you sure you want to delete this token? This cannot be undone!”). Sve što koristi taj token odmah prestaje raditi.

Pošaljite zahtjev

Osnovni URL je https://platform.scratcher.io/api/v1/. Token pošaljite u zaglavlju Authorization i zatražite JSON:

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

Glavne krajnje točke

  • GET /me: korisnik kojem token pripada
  • GET /accounts: računi kojima imate pristup. ID računa koristite u ostalim pozivima.
  • GET /accounts/{account}/campaigns i /campaigns/{campaign}: vaše kampanje
  • GET /accounts/{account}/campaigns/{campaign}/leads: leadovi kampanje, od najnovijih, s njihovim poljima, prihvaćenim privolama te, za dobitnike, nagradom i kodom
  • GET /accounts/{account}/lists i /lists/{list}: vaši popisi leadova
  • /accounts/{account}/lists/{list}/leads: leadovi popisa. GET za čitanje, POST za izradu, PUT za ažuriranje i DELETE za brisanje. Lead ima email, phone_number i neobavezni custom_token.
  • /accounts/{account}/products: proizvodi (GET, POST, PUT, DELETE)
  • /accounts/{account}/placements: položaji (GET, POST, PUT, DELETE)

Popisi su podijeljeni na stranice: dodajte ?page=2 i tako dalje. Možete pristupiti samo računima čiji ste član; ostali ID-jevi računa vraćaju pogrešku.

Ograničenja

Možete poslati 60 zahtjeva u minuti po korisniku. Ako prekoračite ograničenje, API odgovara statusom 429; pričekajte trenutak i pokušajte ponovno.

API referenca

Potpunu referencu sa svim poljima, filtrima, primjerima i Postman kolekcijom pronaći ćete u dokumentaciji API reference. Na nju vodi i gumb API reference na vrhu stranice Settings > API.

Izradite aplikaciju s OAuthom

Ako izrađujete aplikaciju koju drugi korisnici Scratchera povezuju sa svojim računom, umjesto osobnog tokena registrirajte OAuth aplikaciju.

  1. Idite na Settings > API. Pod My apps kliknite Create app („Register an OAuth application for the API.”).
  2. Ispunite Application name (korisnici ga vide kada odobravaju vašu aplikaciju) i Redirect URI (kamo se korisnici vraćaju nakon odobrenja).
  3. Kliknite Save. Prikazat će se poruka „Your app has been created!” s Client ID i Client secret.
  4. Odmah kopirajte tajni ključ klijenta: „Save the client secret above, as this is the only time you will see it.” Kliknite Continue.

Vaša aplikacija šalje korisnike na https://platform.scratcher.io/oauth/authorize s vašim ID-jem klijenta, URI-jem za preusmjeravanje i potrebnim opsezima. Korisnik se prijavljuje u Scratcher i vidi Authorization request: „This application will be able to:”, a zatim popis opsega. Klikne Authorize ili Cancel. Vaša aplikacija zatim kod zamjenjuje za tokene na https://platform.scratcher.io/oauth/token.

  • Pristupni tokeni dobiveni putem OAutha vrijede dva mjeseca. Tokeni za osvježavanje vrijede tri mjeseca; njima dobivate novi pristupni token.
  • Za promjenu naziva ili URI-ja za preusmjeravanje kliknite aplikaciju pod My apps, unesite izmjene i kliknite Save („Your settings have been saved”). „You cannot view your secret afterwards.”
  • Delete app uklanja aplikaciju, a veza svakog korisnika s njom prestaje raditi: „Are you sure you want to delete this app? This cannot be undone!”

Aplikacije koje ste odobrili

Authorized apps prikazuje aplikacije kojima ste dali pristup svom računu, poput Zapiera, zajedno s njihovim opsezima. Kliknite Revoke kako biste ukinuli pristup.

Tko može koristiti API?

Stranica API prikazuje se korisnicima s ulogom Owner, Admin ili Manager. Token nikada ne može učiniti više od korisnika koji ga je izradio.

Trebate pomoć?

I dalje trebate pomoć?

Stvarni ljudi tu su da pomognu. Ako već koristite Scratcher, najbrži je put chat u platformi.

  • Razgovarajte s nama

    Prijavite se i kliknite gumb za chat u donjem desnom kutu. Rex odgovara odmah, a naš tim udaljen je samo jedan klik.

  • Rezervirajte sastanak

    Besplatan 30-minutni videopoziv s našim timom: obilazak, ideje za kampanje ili pomoć s postavljanjem.

  • Pišite nam

    Pišite na contact@scratcher.io i javit ćemo vam se.