Comece a usar a API REST

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:

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. 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.