---
title: "REST API kasutamise alustamine"
description: "Looge sobivate õigustega isiklik juurdepääsuluba või registreerige OAuth-rakendus ning lugege kampaaniaid, leade ja loendeid oma süsteemidest."
url: https://scratcher.io/et/help/developers/rest-api
language: et
---

1. [Abikeskus](https://scratcher.io/et/help)
2. [API, veebikonksud ja MCP](https://scratcher.io/et/help/developers)
3. REST API kasutamise alustamine

# REST API kasutamise alustamine

Looge sobivate õigustega isiklik juurdepääsuluba või registreerige OAuth-rakendus ning lugege kampaaniaid, leade ja loendeid oma süsteemidest.

Scratcheri REST API võimaldab teie enda süsteemidel lugeda teie kampaaniaid, leade ja loendeid, lisada ja uuendada leade ning hallata tooteid ja paigutusi. See artikkel on mõeldud arendajale, kes API seadistab.

API kuulub pakettidesse, mis sisaldavad funktsiooni **Webhooks & API** (Basic ja kõrgemad). Teistes pakettides on lubade ja rakenduste loomise nupud lukus.

## Isikliku juurdepääsuloa loomine

Isiklik juurdepääsuluba on kiireim viis API kasutamiseks oma skriptidest ja süsteemidest.

1. Avage **Settings** > **API** (jaotises **Developers**).
2. Klõpsake jaotises **Personal access tokens** nuppu **Create personal access token**. Dialoogis on kirjas „Generate a token to authenticate API requests.“
3. Andke sellele **Name**, mille hiljem ära tunnete, näiteks „Andmeladu“.
4. Valige jaotises **Scopes**, mida luba teha tohib (vt allpool). **Select all** valib kõik õigused. Andke loale ainult vajalik juurdepääs.
5. Klõpsake **Save**. Kuvatakse teade „Your access token has been created“.
6. Kopeerige luba väljalt **Secret**. „Save the secret above, as this is the only time you will see it.“ Hoidke seda turvaliselt, näiteks paroolihalduris.
7. Klõpsake **Close**.

Luba kuulub teie kasutajale. Sellega pääseb ligi kõigile Scratcheri kontodele, mille liige te olete, valitud õiguste ulatuses.

## Õigused (scopes)

- `read:campaigns` (**View campaigns**): kampaaniate loetlemine ja lugemine
- `read:lists` (**View lists**): leadide loendite loetlemine ja lugemine
- `read:leads` (**View leads**): leadide lugemine
- `write:leads` (**Write leads**): leadide loomine, uuendamine ja kustutamine loendis
- `read:placements` (**View placements**): paigutuste lugemine
- `write:placements` (**Write placements**): paigutuste loomine, uuendamine ja kustutamine
- `read:products` (**View products**): toodete lugemine
- `write:products` (**Write products**): toodete loomine, uuendamine ja kustutamine

Kampaania leadide lugemiseks vajab luba nii õigust `read:campaigns` kui ka `read:leads`. Paigutuste loomiseks ja muutmiseks peab teie paketis olema ka **Embed / URL**.

## Loa tühistamine

Klõpsake loendis loal, et avada **Show personal access token**. Seal on näha **Name** ja **Scopes**. Klõpsake **Revoke** ja kinnitage („Are you sure you want to delete this token? This cannot be undone!“). Kõik, mis luba kasutab, lakkab kohe töötamast.

## Päringu tegemine

Baas-URL on `https://platform.scratcher.io/api/v1/`. Saatke luba päises `Authorization` ja küsige vastust JSON-vormingus:

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

## Peamised lõpp-punktid

- `GET /me`: kasutaja, kellele luba kuulub
- `GET /accounts`: kontod, millele teil on juurdepääs. Kasutage konto ID-d teistes päringutes.
- `GET /accounts/{account}/campaigns` ja `/campaigns/{campaign}`: teie kampaaniad
- `GET /accounts/{account}/campaigns/{campaign}/leads`: kampaania leadid, uusimad eespool, koos nende väljade, aktsepteeritud nõusolekute ning võitjate puhul auhinna ja koodiga
- `GET /accounts/{account}/lists` ja `/lists/{list}`: teie leadide loendid
- `/accounts/{account}/lists/{list}/leads`: loendi leadid. `GET` lugemiseks, `POST` loomiseks, `PUT` uuendamiseks ja `DELETE` kustutamiseks. Leadil on `email`, `phone_number` ja valikuline `custom_token`.
- `/accounts/{account}/products`: tooted (`GET`, `POST`, `PUT`, `DELETE`)
- `/accounts/{account}/placements`: paigutused (`GET`, `POST`, `PUT`, `DELETE`)

Loendid on lehekülgedeks jaotatud: lisage `?page=2` jne. Pääsete ligi ainult kontodele, mille liige te olete; teiste kontode ID-d tagastavad vea.

## Piirangud

Iga kasutaja saab teha 60 päringut minutis. Piirangu ületamisel vastab API olekukoodiga 429; oodake hetk ja proovige uuesti.

## API dokumentatsioon

Täielik dokumentatsioon kõigi väljade, filtrite, näidete ja Postmani kollektsiooniga on saadaval [API dokumentatsioonis](https://platform.scratcher.io/docs/index.html). Sellele viitab ka nupp **API reference** lehe **Settings** > **API** ülaosas.

## Rakenduse loomine OAuthiga

Kui loote rakenduse, mille teised Scratcheri kasutajad oma kontoga ühendavad, registreerige isikliku loa asemel OAuth-rakendus.

1. Avage **Settings** > **API**. Klõpsake jaotises **My apps** nuppu **Create app** („Register an OAuth application for the API.“).
2. Täitke väljad **Application name** (kasutajad näevad seda teie rakendust kinnitades) ja **Redirect URI** (kuhu kasutajad pärast kinnitamist tagasi suunatakse).
3. Klõpsake **Save**. Kuvatakse teade „Your app has been created!“ koos väärtustega **Client ID** ja **Client secret**.
4. Kopeerige kliendisaladus kohe: „Save the client secret above, as this is the only time you will see it.“ Klõpsake **Continue**.

Teie rakendus suunab kasutajad aadressile `https://platform.scratcher.io/oauth/authorize` koos teie kliendi ID, ümbersuunamis-URI ja vajalike õigustega. Kasutaja logib Scratcherisse sisse ja näeb vaadet **Authorization request**: „This application will be able to:“, millele järgnevad õigused. Ta klõpsab **Authorize** või **Cancel**. Seejärel vahetab teie rakendus koodi lubade vastu aadressil `https://platform.scratcher.io/oauth/token`.

- OAuthi juurdepääsuload kehtivad kaks kuud. Värskendusload kehtivad kolm kuud; nendega saab uue juurdepääsuloa.
- Nime või ümbersuunamis-URI muutmiseks klõpsake rakendusel jaotises **My apps**, tehke muudatus ja klõpsake **Save** („Your settings have been saved“). „You cannot view your secret afterwards.“
- **Delete app** eemaldab rakenduse ja kõigi kasutajate ühendus sellega lakkab töötamast: „Are you sure you want to delete this app? This cannot be undone!“

## Teie kinnitatud rakendused

**Authorized apps** loetleb rakendused, millele olete andnud juurdepääsu oma kontole, näiteks Zapier, koos nende õigustega. Juurdepääsu äravõtmiseks klõpsake **Revoke**.

## Kes saavad API-t kasutada?

Lehte **API** näidatakse kasutajatele, kelle roll on **Owner**, **Admin** või **Manager**. Luba ei saa kunagi teha rohkem kui selle loonud kasutaja.

API, veebikonksud ja MCP

- [REST API kasutamise alustamine](https://scratcher.io/et/help/developers/rest-api)
- [Saatke andmeid oma süsteemidesse veebihaakidega](https://scratcher.io/et/help/developers/webhooks)
- [Scratcher MCP teie enda tehisintellekti tööriistadele](https://scratcher.io/et/help/developers/mcp)

Õppige edasi

## Seotud artiklid

- [Saatke andmeid oma süsteemidesse veebihaakidega](https://scratcher.io/et/help/developers/webhooks): Saate päringu oma URL-ile, kui keegi registreerub, osaleb või võidab – allkirjastatud andmete, Basic Auth autentimise, kohandatud andmesisu ja iga saatmise logiga.
- [Scratcher MCP teie enda tehisintellekti tööriistadele](https://scratcher.io/et/help/developers/mcp): Ühendage Claude, ChatGPT ja teised tehisintellekti tööriistad MCP abil oma Scratcheri kontoga. Siit leiate, kuidas seda seadistada ja mida teie tehisintellekt teha oskab.
- [Ühendage Zapieri abil üle 8000 rakenduse](https://scratcher.io/et/help/integrations/zapier): Saatke Scratcheri uued registreerumised Zapieri abil Google Sheetsi, Slacki, oma CRM-i või tuhandetesse teistesse rakendustesse.

Vajate abi?

## Vajate ikka abi?

Päris inimesed on siin, et aidata. Kui juba kasutate Scratcherit, on kiireim viis platvormisisene vestlus.

- **[Vestelge meiega](https://platform.scratcher.io/et/login)**

    Logige sisse ja klõpsake paremas alanurgas vestlusnuppu. Rex vastab kohe ja meie meeskond on ühe klõpsu kaugusel.
- **[Broneeri kohtumine](https://scratcher.io/et/book-a-meeting)**

    Tasuta 30-minutiline videokõne meie meeskonnaga: ringkäik, kampaaniaideed või abi seadistamisel.
- **[Kirjutage meile](mailto:contact@scratcher.io)**

    Kirjutage aadressil contact@scratcher.io ja me vastame teile.
