API Financiador

¿Qué es?

Es un servicio web REST que permite a los financiadores integrar y automatizar en su proceso administrativo la tarea de notificar los resultados de la auditoría y la obtención de tokens para los afiliados.

¿A quién está dirigido?

Este servicio está destinado a aquellos financiadores que tienen la capacidad de integrarse con servicios de terceros, permitiendo reducir el volumen de trabajo.

¿Cómo funciona?

Se consume mediante REST (Representational State Transfer), un estilo de arquitectura de software que proporciona un enfoque práctico y consistente para solicitar y modificar los datos. En el contexto de este servicio, se refiere al uso de los verbos HTTP para recuperar y modificar las representaciones de los datos.
En un sistema RESTful como este, los recursos se alojan en un almacén de datos, un cliente envía una solicitud al servidor para que realice una acción en particular (por ejemplo: crear, recuperar, actualizar o eliminar un recurso), y el servidor contesta con una respuesta, a menudo en la forma de una representación del recurso especificado.
En este servicio, el cliente especifica una acción mediante un verbo HTTP como POST, GET, PUT o DELETE y especifica un recurso por un único URI global de la siguiente forma:

https://www.amr.org.ar/gestion/webServices/{nombreServicio}/{versionServicio}/{ambito}/{recurso}?{parametros}

Versión TEST

https://www.amr.org.ar/gestion/webServices/financiador/test/{ambito}/{recurso}?{parámetros}

Versión PRODUCCION

https://www.amr.org.ar/gestion/webServices/autorizador/v1/{ambito}/{recurso}?{parámetros}

¿Cómo devuelve los datos?

El formato en que retornan los recursos es JSON.
Es un formato de intercambio de datos simple y ligero. Es fácil de leer y escribir y más aún para las máquinas. Se basa en un subconjunto del lenguaje de programación JavaScript.
Es un formato de texto que es completamente independiente del lenguaje pero utiliza convenciones que son familiares para los programadores en lenguajes de la familia C, incluyendo C, C + +, C #, Java, JavaScript, Perl, Python, y muchos otros.
Ejemplo de resultado de resolución de auditoría:

{
   "respuestaComunicacion": {
      "idTransaccion": 527,
      "respuestaBase": {
         "tiposRespuestaValidacion": "OK",
         "mensaje": ""
      }
   }
}

¿Cómo nos identificamos?

El servicio ofrece como método de autenticación el estándar HTTP BASIC. Para ello hay que enviar en cada transacción HTTP el Header correspondiente a esto.

Para construir el Header hay que realizar lo siguiente:

  • Usuario y contraseña combinados con el carácter «:» EJEMPLO: cosme:fulanito
  • Encodear en Base64 el texto anteriormente concatenado EJEMPLO: Base64(cosme:fulanito) = Y29zbWU6ZnVsYW5pdG8=
  • Por último colocar el método de autorización + el tipo + el texto encodeado
    EJEMPLO: Authorization: Basic Y29zbWU6ZnVsYW5pdG8=