AOAPI: Autorizaciones Online API

Es una api que permite integrar los sistemas existentes con nuestro Sistema de Autorizaciones Online.

Seguridad

Todas las consultas realizadas a la api deben ser realizadas con autenticación básica sobre HTTPS. Esto permite autenticarse a través del nombre de usuario y contraseña. Las credenciales enviadas deben estar codificadas en Base64. Las credenciales se deben enviar al servidor en el encabezado 'Authorization' de la siguiente forma:

  1. Nombre de usuario y la contraseña se combinan en una cadena "usuario:contraseña".
  2. La cadena resultante se codifica utilizando Base64
  3. Antes de la cadena codificada se utiliza la palabra "Basic ".
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
El usuario y la contraseña se puede gestionar a través de Autorizaciones Online Web en la sección: "Si es un prestador y no posee cuenta, solicite una."

Respuestas de ERROR

En cada una de las consultas se deberían poder manejar estos errores.

HTTP CÓDIGO TIPO EXPLICACIÓN
400 BadRequest No se envió la solicitud correctamente.
404 NotFound Esto quiere decir que lo que se consultó no fue encontrado.
409 Conflict Ocurrio un error y no pudo ser generada, guardada o modificada una orden.

En caso de generar una orden de consulta, enviamos un mensaje de error para aclarar si alguno de los campos no fue correctamente enviado, como por ejemplo:
{
    "Message": "The request is invalid.",
    "ModelState": {
        "orden.Prescriptor.Apellido": [
            "El campo Apellido es obligatorio."
        ]
    }
}
Esto quiere decir que el Apellido del Prescriptor en la orden no fue enviado.
Esto lo aclaramos en este caso porque los datos a ser enviados son demasiados y al momento de debuggear su app puede ser más fácil resolver el error.