Vamos começar? 😄

Bem vindo

Essa área foi pensada para ajudar você a ter sucesso no desenvolvimento de suas integrações com a API do CRM de Vendas PipeRun. Nosso material irá apoiar e orientar através de documentações e instruções de uso.

Caso esteja procurando pela documentação da API do CRM de Atendimentos PipeRun, acesse por aqui.

Nossa API é baseada no padrão REST, onde o corpo da requisição e da resposta sempre será no formato JSON.
O acesso a API e seus endpoints estão disponíveis através do endereço https://api.pipe.run/v1.

Glossário

Caso seja sua primeira iteração com o nossa API, recomendamos que você se familiarize com os termos da nossa plataforma.

Temos um artigo sobre este tema completo em nossa central de ajuda ao usuário.

Níveis de Acesso

  • G1 - GESTOR DA CONTA: tem acesso geral e administrativo sobre a conta, podendo visualizar todas as informações da base, além de poder configurar todas as ferramentas da mesma, como ações automáticas, ações em massa, integrações e etc.
  • C1 - CONSULTOR: Existem três níveis de permissão:
    • Acesso restrito: consegue visualizar suas empresas, pessoas, oportunidades, atividades, propostas e afins. Não vê nada que não compete a ele;
    • Acesso geral: consegue visualizar empresas, pessoas, oportunidades, propostas, atividades e afins. Enxerga toda a base, indiferente se pertence a ele ou não;
    • Líder de equipe: consegue visualizar empresas, pessoas, oportunidades e afins pertencentes a si mesmo e sua equipe de liderados.

Temos um artigo sobre este tema completo em nossa central de ajuda ao usuário.

Integrações com Business Intelligence (BI) e Exportações

Fornecemos uma solução de CLI e SDK para agilizar o processo de extração de dados usando Python, você pode olhar a documentação especifica no nosso github.
https://github.com/crmpiperun/piperun-extractor

Recomendamos que essa solução seja usada para fins de extrações para BI, Inteligencia Artificial e Backups lógicos.