Aloita REST API:n käyttö

Scratcherin REST API:n avulla omat järjestelmäsi voivat lukea kampanjoitasi, liidejäsi ja listojasi, lisätä ja päivittää liidejä sekä hallita tuotteita. Tämä artikkeli on tarkoitettu kehittäjälle, joka ottaa sen käyttöön. API sisältyy Basic-pakettiin ja sitä ylempiin.

Luo käyttötunnus

1. Siirry kohtaan Asetukset > API (kohdassa Kehittäjät).
2. Klikkaa kohdassa Henkilökohtaiset käyttötunnukset Luo henkilökohtainen käyttötunnus.
3. Anna sille Nimi, esimerkiksi ”Tietovarasto”, ja valitse sen tarvitsemat Käyttöoikeusalueet. Anna sille vain tarvittava pääsy.
4. Klikkaa Tallenna ja kopioi tunnus kohdasta Salaisuus. Näet sen vain kerran, joten säilytä se turvallisesti, esimerkiksi salasanojen hallintaohjelmassa.

Tunnus kuuluu käyttäjällesi, ja sillä pääsee kaikille tileille, joiden jäsen olet. Jos haluat poistaa pääsyn, avaa tunnus ja klikkaa Peruuta.

Käyttöoikeusalueet

• read:campaigns: kampanjoiden lukeminen
• read:lists: liidilistojen lukeminen
• read:leads ja write:leads: liidien lukeminen, luominen, päivittäminen ja poistaminen
• read:placements ja write:placements: sijoittelujen lukeminen ja hallinta
• read:products ja write:products: tuotteiden lukeminen ja hallinta

Tee pyyntö

Perus-URL on https://platform.scratcher.io/api/v1/. Lähetä tunnus Authorization-otsakkeessa:

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

Tärkeimmät päätepisteet

• GET /me: käyttäjä, jolle tunnus kuuluu
• GET /accounts: tilit, joihin sinulla on pääsy
• GET /accounts/{account}/campaigns ja /campaigns/{campaign}: kampanjasi
• GET /accounts/{account}/campaigns/{campaign}/leads: kampanjan liidit palkintoineen, koodeineen ja annettuine suostumuksineen
• GET /accounts/{account}/lists ja /lists/{list}/leads: liidilistat ja niiden liidit sekä POST, PUT ja DELETE liidien hallintaan
• /accounts/{account}/products: tuotteet
• /accounts/{account}/placements: sijoittelut

Tulokset sivutetaan parametrilla ?page=. Raja on 60 pyyntöä minuutissa käyttäjää kohden.

Täydellinen viite esimerkkeineen ja Postman-kokoelmineen on API-viitedokumentaatiossa. Alustan API-viite-painike linkittää myös sinne.

OAuth-sovellukset

Jos rakennat sovelluksen, johon muut Scratcherin käyttäjät yhdistävät, rekisteröi se kohdassa Omat sovellukset > Luo sovellus antamalla Sovelluksen nimi ja Uudelleenohjauksen URI. Saat Client ID- ja Client secret -tiedot. Secret näytetään vain kerran. Ihmisten hyväksymät sovellukset on lueteltu kohdassa Valtuutetut sovellukset, jossa niiden pääsyn voi perua.