> For the complete documentation index, see [llms.txt](https://docs.exoclick.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.exoclick.com/api/pt/api-publica-exoclick/api-de-desenvolvimento.md).
# API de Desenvolvimento
Com a API da plataforma, é possível automatizar todas as funcionalidades encontradas no Painel de Administração.
1. O que os anunciantes podem automatizar?
* Campanhas/grupos, variações, ofertas e formatos de anúncios
* Segmentação/bloqueio de opções de segmentação, categorias
* Objetivos
* Obter estatísticas, incluindo dados de utilizadores com adblock
* Orçamento diário, financiamento da conta, tipos de pagamento
* Nome da página de destino, URL e algoritmo de partilha de tráfego
2. O que os editores podem automatizar?
* Formatos de anúncios e zonas de anúncios
* Sites, verificações de URL
* Bloquear tipos de anúncios e categorias de produtos
* Obter todas as estatísticas, incluindo dados de utilizadores com adblock
* Preços de licitação por formato de anúncio/GEO, modelos de preços
* Tipos de pagamento
3. Como usar a API
* A interface da API é rápida e fácil de usar
* Basta selecionar um parâmetro e premir o **Experimentar** botão para gerar o código automaticamente
4. Transferir a documentação técnica
* [Cliente PHP](https://github.com/exads/exads-api-client-php)
## Como usar a API da plataforma
Acabámos de atualizar a nossa API da plataforma para a versão 2. Esta versão mais recente permite automatizar cada funcionalidade dentro do Painel de Administração. Pode usar a API para processos simples, como automatizar tarefas repetitivas para poupar tempo, até projetos mais complexos, como alterar criativos de banners em tempo real.
### Funcionalidades
Tanto os editores como os anunciantes dispõem de uma vasta gama de funcionalidades. Aqui está um resumo do que pode ser automatizado:
#### Anunciantes
* Campanhas individuais/em grupo, variações, ofertas, formatos de anúncios.
* Segmentação/bloqueio de opções de segmentação, categorias, agendamento por período do dia.
* Objetivos.
* Obter estatísticas, incluindo dados de utilizadores com adblock.
* Orçamento diário, financiamento da conta, tipos de pagamento.
* Nome da página de destino, URL e algoritmo de partilha de tráfego.
#### Editores
* Formatos de anúncios e zonas de anúncios.
* Sites, verificações de URL.
* Bloquear tipos de anúncios e categorias de produtos.
* Obter todas as estatísticas, incluindo dados de utilizadores com adblock.
* Preços de licitação por formato de anúncio/GEO, modelos de preços.
* Tipos de pagamento.
**Antes de começar**
A interface da API mostra uma lista de títulos de grupos. Clique num grupo e todas as opções disponíveis serão expandidas.
### Verbos HTTP
A API suporta o seguinte subconjunto de verbos HTTP. Tenha em atenção que nem todas as funcionalidades suportam todos os verbos.
Vamos começar!
### Configuração
Para aceder a pedidos restritos da API, tem de existir um Token de Sessão definido. Para definir um token, deve ter uma conta válida.
A criação do Token de API está disponível em **O meu perfil** menu. Selecione Tokens de API.
Clique em **Novo Token de API**.
Introduza o nome do token; para este tutorial chamámos ao nosso ‘testToken’ e depois clique em **Guardar**.
O ID do token é criado.
### Iniciar sessão na API
Na interface da API, clique no **Iniciar sessão** botão no canto superior direito do ecrã e introduza o seu nome de utilizador e palavra-passe ou forneça um token de API. Clique em **Enviar** e será enviado um pedido de início de sessão para a API para obter um token de sessão válido. Esse token será depois usado para validar todos os pedidos da API que pretenda fazer durante a sessão.
### Como fazer um pedido à API
Vamos usar o exemplo do grupo Campaigns; clique nele e o grupo será expandido para listar os pedidos disponíveis:
Clique no pedido que pretende automatizar; neste exemplo, vamos pedir dados para o CID 1923724 usando:
Clique em **Obter campanha** o que expande a janela. Introduza o número de ID da campanha no campo:
Depois clique no **Experimentar agora** botão. O corpo da resposta gerará o código automaticamente.
Um código de resposta 200 significa que está tudo bem para usar.
### Como pausar uma campanha
Aqui está outro exemplo. Primeiro selecione a função correta no grupo Campaigns:
Clique em **Pausar** para uma ou mais campanhas. Depois de aberto, clique em Example Value e depois clique na caixa amarela; isto colará automaticamente a estrutura JSON na caixa do corpo.
Agora o valor atual é zero, por isso altere o zero para o CID que pretende colocar em pausa. Depois clique no **Experimente** botão para gerar o código necessário.
### Como atualizar o preço de uma campanha
Selecione a função correta:
Clique em **Atualizar uma campanha**, para abrir a janela. Adicione o CID no campo campaign id e depois clique em Example Value, clique na caixa amarela que copiará a estrutura JSON para a caixa do corpo.
Este código contém algumas funções diferentes, mas queremos o código de preços da campanha, por isso elimine a parte do código que não é necessária, deixando o código de preços da campanha na caixa, como abaixo:
Agora precisamos de alterar duas coisas na caixa do corpo, o modelo (abaixo está uma lista dos valores relacionados com o modelo de preços).
```
CampaignPricing {
model (inteiro, opcional): modelo de preços da campanha (1: CPC, 2: CPM, 3: CPA, 4: Smart CPM, 5: CPV) = [‘1’, ‘2’, ‘3’, ‘4’, ‘5’],
price (número, opcional): preço da campanha
}
```
Vamos manter o CPC, por isso deixaremos o model em 1
Agora precisamos de alterar o preço de zero para o preço que queremos. Vamos alterar isto para 200, o que significa que o novo preço será 200 cêntimos, ou dois euros.
Depois basta clicar no **Experimente** botão para gerar o código. Fácil!
Como pode ver, a API está repleta de funcionalidades para automatizar; o único limite é a sua imaginação para desbloquear o poder da automatização.
Por fim, certifique-se de que subscreve a nossa newsletter da API, que encontra na parte inferior da interface da API, para poder receber as últimas notícias e atualizações.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.exoclick.com/api/pt/api-publica-exoclick/api-de-desenvolvimento.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.