POST Salvar Configurações da Integração
Salva as configurações da integração com Diagnósticos do Brasil. Cria ou atualiza o login, senha e prefixo usados na integração DB.
Autenticação necessária
Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.
Permissão necessária
Exige a permissão read_configurations.
Endpoint
POST https://api-dev.imagemais.com.br/api/integrations/diagnostics-brazil-settings
Corpo da Requisição
| Campo | Tipo | Obrigatório | Valores válidos | Descrição |
|---|---|---|---|---|
login | string | ✅ | não vazio | Login da integração |
password | string | ✅ | não vazio | Senha da integração |
prefix | string | ❌ | até 10 caracteres; formato /^[A-Z0-9]*$/ | Prefixo dos pedidos |
portalServiceCode | string | ❌ | até 50 caracteres | Código de serviço no portal |
portalCpf | string | ❌ | formato /^(\d{11})?$/ | CPF de acesso ao portal |
portalPassword | string | ❌ | — | Senha de acesso ao portal |
Requisição
curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/integrations/diagnostics-brazil-settings' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"login": "texto",
"password": "texto",
"prefix": "texto",
"portalServiceCode": "texto",
"portalCpf": "12345678900",
"portalPassword": "texto"
}'
Respostas
201 Sucesso
400 Requisição inválida
Retornado quando o corpo ou a query não passam na validação. A lista message traz um item por regra violada, por exemplo:
{
"message": [
"O login é obrigatório",
"A senha é obrigatória"
],
"error": "Bad Request",
"statusCode": 400
}
403 Sem permissão
{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}
500 Erro interno
Mensagens possíveis:
Erro ao salvar as configurações da integraçãoDIAGNOSTICS_BRAZIL_ENCRYPTION_SECRET deve estar definido com 16+ caracteres
{
"message": "Erro ao salvar as configurações da integração",
"error": "Internal Server Error",
"statusCode": 500
}