Para usar a API de Exportação dos Dados Assistenciais, o sistema da sua instituição precisa primeiro se autenticar e obter um token de acesso. Esse token, junto com a chave de acesso da instituição (x-api-key), deve ser enviado em todas as consultas de internações e de internações excluídas.
A autenticação é feita pela equipe de TI da instituição, com o usuário e a senha exclusivos da credencial do tipo API Dados Assistenciais, criada pelo Suporte DRG Brasil a pedido do Usuário Administrador.
Como obter e usar o token de acesso
- Tenha em mãos o usuário, a senha e a chave de acesso (
x-api-key) fornecidos pelo Suporte. - Envie uma requisição do tipo POST para o endereço da API de autenticação, informado no manual técnico, com os campos
userName,passwordeoriginno corpo da requisição, em formato JSON. - Se o usuário e a senha estiverem corretos, a API retorna o token de acesso. Armazene esse token para usá-lo nas consultas.
- Em cada consulta à API de exportação, envie no cabeçalho (header) da requisição o token, no campo
Authorization, e a chave de acesso, no campox-api-key. - Gere um novo token sempre que o anterior expirar. O token tem validade de 4 horas.
Exemplo: corpo da requisição de autenticação, com o usuário e a senha da credencial da sua instituição no lugar dos valores de exemplo:
{
"userName": "usuario.api",
"password": "sua-senha",
"origin": "API_DRG"
}Atenção: o token expira a cada 4 horas. Planeje a integração para gerar um novo token antes de iniciar uma nova rotina de consultas, principalmente em cargas longas, com muitas páginas de retorno.
O que enviar na autenticação e nas consultas
| Campo | Onde enviar | Descrição |
|---|---|---|
| userName | Corpo da autenticação | Usuário da credencial API Dados Assistenciais. |
| password | Corpo da autenticação | Senha da credencial. |
| origin | Corpo da autenticação | Origem do acesso. Informe o valor API_DRG. |
| Authorization | Cabeçalho de cada consulta | Token de acesso gerado na autenticação. |
| x-api-key | Cabeçalho de cada consulta | Chave de acesso única da instituição, enviada pelo Suporte. |
Observação: os endereços de autenticação e de consulta estão no manual técnico da API, disponível em Manuais DRG Brasil ou mediante solicitação ao Suporte, pelo e-mail suporte@drgbrasil.com.br.
Artigos Populares
- API de Exportação dos Dados Assistenciais: o que é e para que serve
- Como acessar as credenciais de integração na plataforma
Perguntas Frequentes
O token é válido por 4 horas. Depois desse prazo, é necessário fazer uma nova autenticação para gerar outro token.
Não. O mesmo token pode ser enviado em todas as consultas enquanto estiver dentro do prazo de validade.
Essas informações são enviadas pelo Suporte DRG Brasil após a criação da credencial. O Usuário Administrador da instituição também pode consultar as credenciais na Plataforma.
Não. Toda consulta precisa levar no cabeçalho o token (Authorization) e a chave de acesso da instituição (x-api-key).
Este documento e seus anexos são restritos ao(s) destinatário(s) e poderão ser divulgados apenas para pessoas que necessitem dessas informações para a realização de suas atividades.
Se você o recebeu por engano, entre em contato com o remetente imediatamente e apague-o de seus arquivos.
Qualquer uso não autorizado, replicação ou disseminação deste documento, ou parte dele, é proibido. Antes de imprimir, pense no meio ambiente.
Comentários
0 comentário
Por favor, entre para comentar.