Platforma de APIs de Operadoras de saúde

Construa integrações
com confiança e velocidade

Utilize nossas APIs para integrar com diversas operadoras de saúde e seus serviços relacionados.

Client

Consumer

Portal

Proxy · Docs

API

REST · OpenAPI

POST /auth/tokenrequest

APIs Premium

Selecione uma API para explorar endpoints, schemas e playground.

IZII MDS — Orquestrador de Benefícios (REST)
v2.0.0

API **RESTful** do Orquestrador de Benefícios da Izii — o *Hub de Integração (Facade/Adapter)* que abstrai a comunicação com as operadoras de saúde e odontológicas (Bradesco, SulAmérica, Unimed, Amil, etc.). Esta especificação é a versão **100% REST** do contrato descrito no *Manual de Orientação Técnica — API Orquestrador*. Em vez de um único endpoint `POST` com um campo `movimento` (I/A/E/T/R/C), cada intenção de movimentação cadastral é expressa pelo **verbo HTTP** e por um **recurso** próprio: | Movimento (legado) | Verbo REST | Recurso | |---------------------------|------------|-------------------------------------------| | `I` Inclusão | `POST` | `/v1/beneficiarios` | | `A` Alteração | `PATCH` | `/v1/beneficiarios/{id}` | | `T` Troca de Plano | `PUT` | `/v1/beneficiarios/{id}/plano` | | `E` Exclusão | `DELETE` | `/v1/beneficiarios/{id}` | | `R` Reativação | `POST` | `/v1/beneficiarios/{id}/reativacao` | | `C` Consulta (cadastro) | `GET` | `/v1/beneficiarios` · `/v1/beneficiarios/{id}` | | Buscar movimentações | `GET` | `/v1/movimentacoes` · `/v1/movimentacoes/{id}` | ## Autenticação A entrada exige `consumerKey`, `consumerSecret` e `tenantId`, que geram um **token JWT** temporário (validade de 2 horas). O token deve ser enviado no header `Authorization: Bearer <token>` em todos os endpoints de negócio. Veja `POST /v1/auth/token`. ## Multi-tenancy e roteamento - O **inquilino** (`tenantId`) é resolvido a partir do token JWT. - A **operadora de destino** é informada no header `X-Cnpj-Provedor` (CNPJ da operadora — ex. SulAmérica `01685053000156`), que atua como *chave de roteamento* (padrão Mediator). ## Padronização de respostas Independentemente do formato devolvido por cada operadora (XML legado, JSON da SulAmérica, etc.), o Orquestrador converte tudo para schemas padronizados. Operações de escrita retornam um `MovimentacaoResultado` com `protocolo`, `status` e a lista de `criticas` (validações de negócio). Erros seguem o schema `Erro`.

Abrir