Validação Externa de Membro

Verifica se o numero de membro e o NIF correspondem a um enfermeiro.

Changed on

Este endpoint deve ser usado por integracoes externas autorizadas pela Ordem dos Enfermeiros. Nao usa JWT; a autenticacao e feita com o username e password tecnicos enviados no corpo do pedido.

Exemplo de pedido:

POST /api/external-member-validation/verify
Content-Type: application/json
        
{
  "username": "credencial-tecnica",
  "password": "palavra-passe-tecnica",
  "numero_membro": "12345",
  "nif": "123456789"
}
        

Exemplo de resposta com sucesso:

{
  "success": true,
  "nome_completo": "Maria Silva",
  "estado": "Ativo"
}
post/api/external-member-validation/verify

Request

  • Base URL
    https://api.ordemenfermeiros.pt (the document declares no server; this is the origin it was published from)
  • URL
    https://api.ordemenfermeiros.pt/api/external-member-validation/verify
  • Auth
    none declared

Request body

usernamestring required

Username tecnico fornecido pela Ordem dos Enfermeiros.

passwordstring required

Password tecnica associada ao username.

numero_membrostring required

Numero de membro da Ordem dos Enfermeiros.

nifstring required

Numero de identificacao fiscal do membro.

Example request

{
  "username": "credencial-tecnica",
  "password": "palavra-passe-tecnica",
  "numero_membro": "12345",
  "nif": "123456789"
}

Response

OK

successboolean

Indica se a validacao foi concluida com sucesso.

nome_completostring

Nome completo do enfermeiro encontrado.

estadostring

Estado atual do membro.

Example response

{
  "success": true,
  "nome_completo": "Maria Silva",
  "estado": "Ativo"
}

Changes