Base de Conhecimento

Tópico
O que é uma API?
Como uma API funciona no Pipedrive?

O que é uma API?

SR
Steven Reinartz, 13 de novembro de 2024
Observação: para informações mais detalhadas sobre como usar a API do Pipedrive, visite esta página.

O Pipedrive oferece uma variedade de recursos automatizados e integrações de terceiros que facilitam o seu trabalho e aumentam a sua eficiência.

Porém, se você busca uma comunicação mais avançada entre o seu site e a sua conta do Pipedrive, talvez seja interessante usar a API.


O que é uma API?

Observação: uma API pode ser algo complexo de configurar e usar, e é uma ferramenta usada principalmente por desenvolvedores de software. Se você não possui conhecimento técnico nessa área, recomendamos visitar o nosso Developer's corner para informações mais detalhadas.

De maneira simples, API (interface de programação de aplicações) é uma maneira de duas ou mais aplicações se comunicarem.

Isso pode ser algo simples, como buscar informações em um banco de dados externo, ou algo mais complicado, como manipular dados em massa. Porém, uma API é uma ponte que conecta as empresas para economizar o tempo dos funcionários.

Termos básicos de uma API

Veja uma breve lista com termos e definições relacionados a APIs.

Chamada de API
O ato de enviar uma solicitação para sua API após configurar um endpoint
Endpoint de API
O fim de cada ponto de cada touchpoint em uma interação de API.
Solicitação de API
Quando um desenvolvedor adiciona um endpoint a uma URL e o utiliza para chamar um servidor ou banco de dados.
Um identificador único usado durante solicitações de API para garantir que uma pessoa ou software realmente é quem diz ser.
Integração de API
Uma conexão entre duas ou mais aplicações para trocar dados usando a API.
JSON
(JavaScript Object Notation) é um formato de API que usa a linguagem JavaScript. Usar uma API normalmente requer um nível básico de conhecimento de linguagem de script.
Observação: para mais informações sobre quais usuários podem ter acesso à API na sua conta, consulte este artigo.

Casos de uso comuns de APIs

Veja algumas aplicações comuns de API para páginas da web.

  • Integrar sistemas internos e externos;
  • Adicionar outras funcionalidades;
  • Reduzir os custos;
  • Melhorar a segurança interna.
Observação: para ver outros casos de uso de APIs com mais detalhes, acesse esta página.

Como uma API funciona no Pipedrive?

Observação: para manter seus dados seguros, é extremamente importante não compartilhar o seu token de API com outras pessoas. Se você acredita que alguém tem acesso ao seu token de API, clique em "Gerar novo token" para gerar um novo. Depois, você precisará atualizar todas as conexões de API existentes com o novo token.

Para criar uma conexão de API entre sua conta do Pipedrive e outra aplicação, encontre sua chave pessoal de API indo em Configurações > Preferências pessoais > API.

Com seu token em mãos, você precisará de uma plataforma para facilitar suas solicitações de API, como o Postman.

Configurando o Postman

Observação: o Postman não é uma ferramenta do Pipedrive, mas pode ser usado para executar ações de API na sua conta. Para ver um guia detalhado sobre o Postman e como ele funciona, acesse esta página.

Para usar o Postman como sua plataforma de API, clique este link para acessar o nosso Developer's corner, baixe o Postman usando o link fornecido ou clique em "Executar no Postman" caso já tenha feito o download.

Após criar sua "fork collection", você será direcionado para o espaço de trabalho do Postman, onde poderá ver as solicitações de API disponíveis através do Pipedrive à esquerda.

Para criar uma solicitação de API, normalmente é necessário ter algumas coisas:

  • Seu token de API;
  • Um endpoint (por ex., negócios);
  • Um verbo HTTP (por ex., GET).
Observação: o Pipedrive utiliza a Referência de API RESTful, e você pode acessá-la juntamente com uma lista de endpoints e suas descrições nesta página para desenvolvedores. Para ver a lista dos endpoints, clique na seta próxima da Referência de API no topo da página.
Este artigo foi útil?

Sim

Não

Artigos relacionados

Tem uma pergunta?

Entre em contato conosco