# Pipo Public API

- [Introdução](https://docs.piposaude.com.br/docs/comecar/introducao.md): Visão geral da Pipo Public API
- [Autenticação](https://docs.piposaude.com.br/docs/comecar/autenticacao.md): Como obter suas credenciais, gerar o token Bearer e autenticar as requisições.
- [Convenções](https://docs.piposaude.com.br/docs/comecar/convencoes.md): Regras que valem para toda requisição e resposta da API.
- [Como fazer uma inclusão](https://docs.piposaude.com.br/docs/guias/inclusao.md): Incluir novos membros, grupos familiares ou benefícios em membros existentes.
- [Como fazer uma exclusão](https://docs.piposaude.com.br/docs/guias/exclusao.md): Excluir benefícios de um membro: primários, como dependente, ou um benefício específico.
- [Webhooks](https://docs.piposaude.com.br/docs/guias/webhooks.md): Receba notificações de acompanhamento do status das movimentações via HTTP POST.
- [Erros](https://docs.piposaude.com.br/docs/referencia/error-handling/erros.md): Códigos de status HTTP retornados pela API.
- [Ofensas](https://docs.piposaude.com.br/docs/referencia/error-handling/ofensas.md): Catálogo de offenses (violações de validação) retornadas nas movimentações.
- [Common types](https://docs.piposaude.com.br/docs/referencia/data-types/common-types.md)
- [Enums](https://docs.piposaude.com.br/docs/referencia/data-types/enums.md)
- [Custom types](https://docs.piposaude.com.br/docs/referencia/data-types/custom-types.md)
- [Changelog](https://docs.piposaude.com.br/docs/referencia/changelog.md): Histórico de versões e mudanças da API e da documentação.
- [Autenticar](https://docs.piposaude.com.br/api-reference/autenticar.md): Autentica o cliente usando as credenciais e retorna um token Bearer a ser usado no header `Authorization` das demais chamadas.
- [Listar empresas](https://docs.piposaude.com.br/api-reference/listar-empresas.md): Lista todas as empresas disponíveis para o cliente.
- [Obter empresa](https://docs.piposaude.com.br/api-reference/obter-empresa.md): Obtém os dados de uma empresa específica pelo CNPJ.
- [Histórico de movimentações da empresa](https://docs.piposaude.com.br/api-reference/historico-empresa.md): Lista o histórico de movimentações de uma empresa específica.
- [Listar membros da empresa](https://docs.piposaude.com.br/api-reference/membros-empresa.md): Lista os membros de uma empresa específica.
- [Listar produtos](https://docs.piposaude.com.br/api-reference/listar-produtos.md): Lista todos os produtos disponíveis ao cliente, com as empresas em que são válidos.
- [Histórico completo de movimentações](https://docs.piposaude.com.br/api-reference/historico.md): Lista o histórico completo de movimentações de todas as empresas às quais o cliente tem acesso.
- [Movimentações em andamento](https://docs.piposaude.com.br/api-reference/em-andamento.md): Lista as movimentações ativas/em andamento de todas as empresas às quais o cliente tem acesso.
- [Inclusão em lote](https://docs.piposaude.com.br/api-reference/inclusao-em-lote.md): Inclui novos membros e/ou grupos familiares em lote.
- [Inclusão de benefício em membro existente](https://docs.piposaude.com.br/api-reference/inclusao-beneficio.md): Inclui um novo benefício para um membro já existente.
- [Exclusão de benefícios primários](https://docs.piposaude.com.br/api-reference/exclusao-primarios.md): Exclui todos os benefícios primários de um membro na empresa-alvo.
- [Exclusão de benefícios de dependente](https://docs.piposaude.com.br/api-reference/exclusao-dependente.md): Exclui os benefícios em que o membro é dependente do titular informado.
- [Exclusão de um benefício específico](https://docs.piposaude.com.br/api-reference/exclusao-beneficio.md): Exclui um único benefício do membro.
- [Detalhe de uma movimentação](https://docs.piposaude.com.br/api-reference/detalhe.md): Retorna os detalhes de uma movimentação específica.
- [Gerar URL de upload de documento](https://docs.piposaude.com.br/api-reference/upload-url.md): Gera um `document-id` e uma URL para que o documento seja enviado ao file-storage da Pipo. A URL fica habilitada para receber o upload (**via POST ou PUT**) por **30 minutos** após ter sido gerada, **ou até receber algum dado** — o que ocorrer primeiro.
- [Listar todos os membros](https://docs.piposaude.com.br/api-reference/listar-membros.md): Lista todos os membros de todas as empresas às quais o cliente tem acesso.
- [Obter membro](https://docs.piposaude.com.br/api-reference/obter-membro.md): Retorna os detalhes de um membro específico.
- [Consultar status de requisição](https://docs.piposaude.com.br/api-reference/consultar-requisicao.md): Consulta o status e os detalhes de uma requisição assíncrona.
- [Health check](https://docs.piposaude.com.br/api-reference/health-check.md): Verifica a disponibilidade da API. Não requer autenticação.

## OpenAPI Specs

- [openapi](/openapi.yaml)