API

Início

A API do Bulldesk é organizada em torno do REST (opens new window). Nossa API tem URLs previsíveis, baseadas no nome do recurso e utiliza códigos de respostas HTTP que identificam erros.

Usamos recursos incorporados, como autenticação e verbos HTTP, que são compreendidos por todos os clientes. Todas as requisições para a API devem ser feitas via HTTPS. Todas as respostas da API retornam JSON.

Autenticação

Token Público

Para utilizar a API do Bulldesk de conversões, é necessário somente o token público de acesso.

Clique aqui para visualizar seu token público.

Esse token deve ser passado diretamente como parâmetro da requisição.

Token Privado

As demais requisições à API devem ser feitas através de um token privado.

Clique aqui para acessar a área de integrações e criar seu token.

Lembre-se: Esse token tem acesso à todos os seus dados e nunca deve ser exposto.

Caso seu token seja comprometido, acesse a área de integrações e apague-o imediatamente.

A autenticação através do token é feita com os seguintes headers:

Accept: application/json
Authorization: Bearer <TOKEN_PRIVADO>

TIP

No lugar de <TOKEN_PRIVADO> adicione seu token gerado nas configurações do Bulldesk.

Conversões

Criar Conversão [POST https://api.bulldesk.com.br/conversion]

Cria uma nova conversão e atualiza os dados do lead.

Um novo lead será cadastrado caso ele não exista na base de dados.

• Parâmetros:
  • token (string, required) - Token de acesso a API
  • identifier (string, required) - Identificador da conversão
  • email (string, required) - E-mail do lead
  • client (string, optional) - Client ID, utilizado para análise de origens e campanhas.
  • domain (string, optional) - Domínio em que o lead converteu.
  • name (string, optional) - Nome do lead
  • company (string, optional) - Empresa do lead
  • occupation (string, optional) - Profissão / cargo do lead
  • phone (string, optional) - Telefone do lead
  • website (string, optional) - Site do lead

TIP

Campos customizados cadastrados dentro do Bulldesk (opens new window) também podem ser enviados na requisição.

Leads

Listar Leads [GET https://api.bulldesk.com.br/lead]

Lista todos os leads da base em uma paginação. São exibidos 20 leads por página.

• Parâmetros:
  • page (integer, optional) - Número da página