Nomenclatura EndPoint e versionamento (Design)

- Priorizar para expor sempre serviços REST

- Definir as entidades. Ex.: /clientes (sempre plural)
- Versionamento. Ex: /v1
- Contexto. Ex /rede-credenciada (não utilizar verbo, sempre
minúsculo e separar por hífen)
- Utilizar os “verbos” corretamente: GET, POST, PUT e DELETE
- Pesquisas, utilizar o verbo GET e filtros via “query param”
-
https://api.centralnacionalunimed.com.br/clientes/v1/beneficiario/086537
16004876001/dependente

Políticas de ciclo de vida das APIs

- Manter pelo menos uma versão anterior da API;
- Análise do que a API precisa fazer;
- Design. Definir entidades, versões, contexto e etc
- Implementação. Elaborar MOCKs;
- Testes (Ex. Postman)
- Publicação;
- Melhoria contínua (LEAN)
- Descontinuidade;

Mecanismo segurança, autenticação e certificados

- Instalar o certificado diretamente no API Manager
- Recomendamos trabalhar com o OAuth 2.0, utilizando como token
o JWT.
- Client Credentials: Autenticação de backend to backend
(interno CNU);
- Password: Autenticação recomendada para o APP, onde é
utilizado um Token a cada chamada. Existe a possibilidade
de efetuar um “refresh token” caso o tempo do token expire.
 - Authorization Code: Login social. Também é mais indicado
para páginas WEB ou aplicações de terceiros.
- Autorização. Fixar como regra que o consumo da API será
restrita, por beneficiário. A informação da autorização estará
no TOKEN JWT.

Timeout
- Será definido caso a caso. Possivelmente um GET pode precisar
de um tempo maior de execução.

Papéis e Controle de acessos

- Aguardando a liberação do ambiente

Throttling
- Conexões por segundo ou simultâneas;
- O Throttling serve como uma “fila” que filtra o que chega no API
Manager.
- Pode ser configurado para manter a conexão na fila, aguardando
a liberação do canal, ou retornar com falha de conexão.

Criação de Dashboards de acompanhamento

- Aguardando a liberação da ferramenta

Composição
É possível fazer composição, consumindo APIs REST ou SOAP.
Pode ser feito de forma simultânea.

Regras de transformação de campos

- Não existe uma regra.

De/Para e Para/De
- Orquestração dentro da ferramenta. Dentro desta orquestração, é
possível chamar uma outra api interna em “cache”.

Cache
- Definir tempo, quantidade de registros e também o tamanho (KB)
- Verificar o que a CNU contratou. Quais os limites.

Entidades:
● autenticacao
○ login
○ login-cpf
○ token

● usuarios
○ GET
○ POST
○ PUT
○ DELETE
○ reset-senha

● beneficiarios
 ○ cartao
○ carencia
○ extrato-utilizacao
○ irpf
■ enviar-email

● autorizacoes
○ beneficiario
○ detalhe

● reembolsos
○ imagem
○ POST
○ previa
○ beneficiario

● rede-credenciada
○ GET
○ tipo-prestador
○ especialidade

https://api.centralnacionalunimed.com.br

/autenticacao/login
POST
FORM PARAM

/autenticacao/login-cpf
POST
FORM PARAM

/autenticacao/token/[013425245234]
GET
/beneficiarios/cartao/