👤 Para admins e super admins
🔐 Disponível para todos os planos
🎯 Para quem quer conectar processos na Pipefy com outras ferramentas
⏩ Resumo:
Se os processos da sua empresa dependem de outras ferramentas além do Pipefy, você pode utilizar nossa API para otimizar seu trabalho.
Como esta é uma funcionalidade low-code, você precisa ter um conhecimento mínimo no assunto para utilizá-la.
Portanto, se esta é sua primeira experiência, recomendamos que você faça o nosso curso básico de APIs e integrações da Pipefy, que é totalmente gratuito. Também temos mais conteúdos sobre isso no Pipefy Developers e na nossa Comunidade.
O que é uma API?
API é uma sigla para Application Programming Interface e funciona como uma conexão entre softwares ou entre computadores.
Seu objetivo é simplificar a programação e torná-la mais segura, mostrando apenas as informações e ações necessárias para o desenvolvimento.
A API do Pipefy pode ser utilizada para integrações com sistemas próprios ou de terceiros, desde que possuam uma API pública.
💡 Dica: Vale ressaltar que a API a ser conectada deve aceitar requisições CORS (cross-origin resource sharing), um mecanismo que permite um site acessar recursos de outro mesmo estando em domínios diferentes. Saiba mais sobre CORs.
Pra quê serve?
No geral, as APIs evitam o trabalho dobrado. Se você utiliza um ou mais softwares além do Pipefy no seu processo, pode criar uma API para:
Transferir informações de uma plataforma à outra;
Automatizar atividades, como criar cards, atualizar ou deletar informações em massa;
Editar campos em cards;
Criar e editar registros no seu database.
GraphQL
O GraphQL é uma linguagem de busca e manipulação de APIs Web criada pelo Facebook. Este também é o nome dado ao back-end que fornece informações no formato GraphQL. Você pode utilizá-la junto com outras linguagens como Node, Ruby e Phyton.
No GraphQL temos queries, que usamos para fazer consultas, e mutations, utilizadas para alterar dados na API.
🔎 Aqui você encontra uma introdução sobre os endpoints do GraphQL da Pipefy.
🔎 E aqui uma série de referências sobre queries, mutations e mais!
Acessos
Para usar a API do Pipefy, você tem duas opções:
IDE pública ou GraphQL playground: Utilizada apenas para auxiliar nos comandos. Não é necessário código de autorização, já que está sincronizada com a autenticação de usuário no Pipefy. Alterações e mutations feitas nessa área vão refletir no seu pipe. Não é possível criar automações ou robôs na IDE pública.
URL de desenvolvimento (endpoint): Use para fazer solicitações em nossa API e criar integrações personalizadas que melhor atendam às suas necessidades.
Autenticação
Para autenticação do Pipefy GraphQL, você precisará de um token OAuth2 Bearer.
Existem duas formas de autenticação no GraphQL, a mais recomendada é Contas de Serviço para ambientes de produção devido à sua segurança e gerenciamento da organização. A outra é usando um Personal Access Token, ideal para usuários que farão testes na API ou chamadas em seus próprios Pipes.
Para saber como obter a sua chave da Conta de Serviço e o seu passo a passo, clique aqui. Se escolher utilizar o Personal Access Token, siga este passo a passo:
Vá para: https://app.pipefy.com/tokens;
Clique em Gerar novo token;
Dê uma descrição ao token;
Clique em Salvar;
Consulte o token conforme necessário ao autenticar no Pipefy.
🔔 Atenção: Somente admin ou super admin pode utilizar a API do Pipefy. Saiba mais sobre funções e permissões no Pipefy.
Como as APIs são contabilizadas no seu plano
Cada plano do Pipefy contabiliza APIs de uma forma diferente:
No plano Starter, você tem direito a até 20 chamadas de APIs por mês;
No plano Business, até 500 chamadas;
No plano Enterprise, até 10.000 chamadas;
E no plano Unlimited elas são customizadas.
Uma chamada de API é uma solicitação enviada ao servidor, para que ela retorne com uma informação. Por exemplo: busque cards com título X, no pipe Y.
Limite de solicitações
O número de consultas subsequentes permitidas por unidade de tempo é de 500 solicitações a cada 30 segundos. Se este número for excedido, o usuário não poderá fazer uma solicitação de API por 5 minutos;
O número de configurações de webhooks é baseado no tamanho do processo e também depende da assinatura da organização. Recomendamos não ter mais de 30 webhooks para cada pipe, mas isto pode variar;
As entradas e saídas são baseadas principalmente no tamanho do seu processo, usando as queries e mutations pré-construídas. No geral, cada solicitação retorna apenas 50 registros, exigindo então o uso de paginação;
O limite para tamanho dos arquivos anexos é de 512 MB para cada arquivo;
Por motivos de segurança, links de arquivos gerados ficam disponíveis por 15 minutos somente.
Conteúdos Relacionados
🎓 Aprenda a fazer muito mais com os cursos gratuitos da Pipefy Academy!
🌎 Faça parte da Comunidade do Pipefy para tirar dúvidas, compartilhar sugestões, ficar por dentro das novidades e dividir seu conhecimento com pessoas do mundo todo!