Introdução

A Pipo Public API é uma API HTTP que fornece acesso aos serviços da Pipo Saúde. Por meio dela, disponibilizamos dados e funcionalidades que existem na Plataforma do RH, ao qual analistas do RH têm acesso. Esta documentação é técnica, apropriada a times de tecnologia, e descreve o fluxo de autenticação, todos os endpoints disponíveis, parâmetros e respostas esperadas. A API foi pensada para:

• Times de tecnologia de empresas clientes que queiram integrar suas ferramentas internas à Pipo.
• Parceiros de integração que constroem e mantêm integrações em nome do RH.
• Sistemas de folha de pagamento que precisam refletir movimentações de benefícios de forma automatizada.

​

Caso de uso: integração com software de folha

Um caso de uso bastante comum solicitado pelo RH é a integração da API ao software de folha da empresa (Tako, TOTVS Protheus, Senior HCM, ADP Workforce, entre outros). Hoje, a API da Pipo não se integra diretamente a esses sistemas, mas é possível construir essa integração entre o seu software de folha e a API. Indicamos um destes três caminhos:

1. Entrar em contato com a Pipo (via gerente de contas) para explorar uma solução piloto.
2. Delegar a integração para a sua própria equipe de tecnologia, que ficará responsável por criá-la e mantê-la.
3. Contratar um parceiro terceiro para criar e manter a integração. Hoje temos um parceiro validado que indicamos abaixo.

​

Ambientes

A API está disponível em dois ambientes: Todos os endpoints são versionados sob o prefixo /v1.

​

Próximos passos