Enpdoint de registro do RES (Cemig)
- Rafael Simão Xavier
1- URL base API
Ambientes | URL |
|---|---|
Homologação | https://csig1g-prj-protheus.totvscloud.com.br:50087/rest |
Produção |
|
2- Endpoint
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
/res/autorizacao | POST | application/json |
|
3- Headers
Autenticação a ser definida
Chave | Valor | Descrição |
|---|---|---|
Authorization |
| Token interno |
4- Parâmetros envio
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| TRUE | String | Chave única do beneficiário que está solicitando (Usuário logado) |
| TRUE | String | Chave única do beneficiário |
| TRUE | String | Este campo pode receber AUTORIZADO – Autorização ou REVOGADO - Revogação |
| cONDiCIONAL | Object | Objeto contendo informações dos termos de uso Obrigatório quando o campo “situacao” for AUTORIZADO |
Objeto termos_uso
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| TRUE | Int | ID do termo de uso na Mobile Saúde |
| TRUE | Int | Versão do termo de uso |
| TRUE | String | Data publicação no formato "2024-05-09T15:11:09.000Z" |
5- Body request (JSON)
Situação REVOGADO
{
"chaveUnicaSolicitante": "12345678900",
"chaveUnica": "12345678900",
"situacao": "REVOGADO"
}Situação AUTORIZADO
{
"chaveUnicaSolicitante": "12345678900",
"chaveUnica": "12345678900",
"situacao": "AUTORIZADO",
"termosUso": {
"idTermoUso": 713,
"versao": 5,
"dataPublicacao": "2024-05-09T15:11:09.000Z"
}
}
6- Exemplo de retorno de sucesso (Status code 200)
{
"status": true,
"data": {},
"mensagem": "Registro realizado com sucesso!"
} |
7- Retorno de erro
{
"status": false,
"data": {},
"mensagem": "O campo protocolo é obrigatório."
} |
Related content
Mobile Saúde - Mosia Omnichannel