Endpoints

Os endpoints da nossa API utilizam o padrão de arquitetura REST (Representational State Transfer - Transferência de Estado Representacional) que é uma abordagem arquitetural simples, escalável e interoperável. Esse padrão utiliza conceitos como recursos, operações CRUD (mapeadas com os métodos HTTP: POST, GET, PUT/PATCH e DELETE) e URIs para definir uma interface padrão e uniforme para a comunicação entre clientes e servidores. Os recursos têm uma ou mais representações, que podem ser em formatos como JSON, XML, HTML, entre outros.

Utilizamos o formato JSON para transferência de dados. Portanto, é necessário utilizar o seguinte cabeçalho nas requisições do tipo POST:

 "Content-Type": "application/json"

Nas próximas páginas, você terá acesso a informações detalhadas sobre os recursos disponíveis, exemplos de uso e outros conceitos relevantes para a integração.

Não deixe de conferir a seção “Referência” que fornece uma visão mais técnica da API!

Paginação

Alguns endpoints possuem paginação para limitar a quantidade de registros retornados em cada requisição. Para habilitar a paginação, envie o parâmetro paginate=S na requisição:

GET /api/subscribers?paginate=S

Quando o parâmetro paginate não for informado ou estiver diferente de S, o endpoint seguirá o comportamento padrão, sem paginação.

Quando a paginação estiver habilitada, a resposta será retornada com a seguinte estrutura:

{
  "data": [],
  "links": {
    "first": ".../api/subscribers?paginate=S&amp;page=1",
    "last": ".../api/subscribers?paginate=S&amp;page=2",
    "prev": null,
    "next": ".../api/subscribers?paginate=S&amp;page=2"
  },
  "meta": {
    "current_page": 1,
    "last_page": 2,
    "per_page": 500,
    "total": 510
  },
  "response": "success"
}

Campos da paginação:

Campo	Descrição
`data`	Registros retornados na página atual.
`links.first`	URL da primeira página.
`links.last`	URL da última página.
`links.prev`	URL da página anterior. Retorna `null` quando não houver.
`links.next`	URL da próxima página. Retorna `null` quando não houver.
`meta.current_page`	Número da página atual.
`meta.last_page`	Número total de páginas.
`meta.per_page`	Quantidade de registros por página.
`meta.total`	Quantidade total de registros.
`response`	Status da resposta.

Para acessar uma página específica, utilize o parâmetro page:

GET /api/subscribers?paginate=S&amp;page=2

Simulação de Ativação