---
title: "Comece a usar a API REST"
description: "Crie um token de acesso, escolha os âmbitos e leia campanhas, leads e listas a partir dos seus próprios sistemas."
url: https://scratcher.io/pt/help/developers/rest-api
language: pt
---

1. [Centro de ajuda](https://scratcher.io/pt/help)
2. [API, webhooks e MCP](https://scratcher.io/pt/help/developers)
3. Comece a usar a API REST

# Comece a usar a API REST

Crie um token de acesso, escolha os âmbitos e leia campanhas, leads e listas a partir dos seus próprios sistemas.

A API REST do Scratcher permite que os seus próprios sistemas leiam as suas campanhas, leads e listas, adicionem e atualizem leads e giram produtos. Este artigo destina-se ao programador que faz a configuração. A API faz parte do plano Basic e superiores.

## Criar um token de acesso

1. Vá a **Definições** > **API** (em **Programadores**).
2. Em **Tokens de acesso pessoal**, clique em **Criar token de acesso pessoal**.
3. Dê-lhe um **Nome**, como "Data warehouse", e escolha os **Âmbitos** de que precisa. Dê-lhe apenas o acesso necessário.
4. Clique em **Guardar** e copie o token em **Secret**. Só o vê uma vez, por isso guarde-o em segurança, por exemplo num gestor de palavras-passe.

Um token pertence ao seu utilizador e tem acesso a todas as contas de que é membro. Para remover o acesso, abra o token e clique em **Revogar**.

## Âmbitos

- `read:campaigns`: ler campanhas
- `read:lists`: ler listas de leads
- `read:leads` e `write:leads`: ler, criar, atualizar e eliminar leads
- `read:placements` e `write:placements`: ler e gerir posicionamentos
- `read:products` e `write:products`: ler e gerir produtos

## Fazer um pedido

O URL base é `https://platform.scratcher.io/api/v1/`. Envie o token no cabeçalho `Authorization`:

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

## Endpoints principais

- `GET /me`: o utilizador a quem pertence o token
- `GET /accounts`: as contas a que tem acesso
- `GET /accounts/{account}/campaigns` e `/campaigns/{campaign}`: as suas campanhas
- `GET /accounts/{account}/campaigns/{campaign}/leads`: os leads de uma campanha, com prémios, códigos e consentimentos aceites
- `GET /accounts/{account}/lists` e `/lists/{list}/leads`: listas de leads e os respetivos leads, além de `POST`, `PUT` e `DELETE` para gerir leads
- `/accounts/{account}/products`: produtos
- `/accounts/{account}/placements`: posicionamentos

Os resultados são paginados com `?page=`. O limite é de 60 pedidos por minuto por utilizador.

A referência completa, com exemplos e uma coleção Postman, está na [documentação de referência da API](https://platform.scratcher.io/docs/index.html). O botão **Referência da API** na plataforma também tem ligação para ela.

## Aplicações OAuth

Se criar uma aplicação a que outros utilizadores do Scratcher se ligam, registe-a em **As minhas aplicações** > **Criar aplicação**, com um **Nome da aplicação** e um **URI de redirecionamento**. Recebe um **ID do cliente** e um **Client secret**. O secret só é mostrado uma vez. As aplicações que as pessoas aprovaram aparecem em **Aplicações autorizadas**, onde podem ser revogadas.

API, webhooks e MCP

- [Comece a usar a API REST](https://scratcher.io/pt/help/developers/rest-api)
- [Envie dados para os seus sistemas com webhooks](https://scratcher.io/pt/help/developers/webhooks)
- [Scratcher MCP para as suas próprias ferramentas de IA](https://scratcher.io/pt/help/developers/mcp)

## Artigos relacionados

- [Envie dados para os seus sistemas com webhooks](https://scratcher.io/pt/help/developers/webhooks): Receba um pedido no seu próprio URL quando alguém se regista ou ganha, com um payload assinado e um registo de cada entrega.
- [Scratcher MCP para as suas próprias ferramentas de IA](https://scratcher.io/pt/help/developers/mcp): Em breve poderá ligar o Claude, o ChatGPT e outras ferramentas de IA ao Scratcher com MCP. Eis o que sabemos até agora.
- [Ligue mais de 8000 aplicações com o Zapier](https://scratcher.io/pt/help/integrations/zapier): Envie os novos registos do Scratcher para o Google Sheets, o Slack, o seu CRM ou milhares de outras aplicações com o Zapier.

## Ainda precisa de ajuda?

Há pessoas reais prontas para ajudar. Se já usa o Scratcher, o mais rápido é o chat dentro da plataforma.

- **[Fale connosco no chat](https://platform.scratcher.io/login)**

    Inicie sessão e clique no botão de chat no canto inferior direito. O Rex responde de imediato e a nossa equipa está à distância de um clique.
- **[Marque uma reunião](https://scratcher.io/pt/book-a-meeting)**

    Uma videochamada gratuita de 30 minutos com a nossa equipa: uma demonstração, ideias de campanhas ou ajuda com a sua configuração.
- **[Envie-nos um e-mail](mailto:contact@scratcher.io)**

    Escreva para contact@scratcher.io e entraremos em contacto consigo.