La función de esta API es únicamente proveer información (por ejemplo, métodos de pago y claves de referencia) para ser utilizados con otro servicio.

El presente manual de integración está dirigido a los usuarios de perfil técnico (analistas, ingenieros o programadores) que son quienes podrán llevar adelante la integración de vuestros sistemas con nuestra API de consultas.

Este manual de integración desde su sitio Web, portal web o intranet proporciona información sobre la mayoría de las funciones que esta API proporciona, así como explicaciones de cómo utilizarlas.

2.1. ¿ Qué es una API ?

Una API (del inglés Application Programming Interface, o Interfaz de Programación de Aplicaciones) es un conjunto de reglas, protocolos y herramientas que permiten que dos programas o sistemas distintos se comuniquen entre sí.
En nuestro caso utilizamos una API Web.

3.1 URL de Producción y Sandbox

Para consumir la API, debes realizar una petición POST a la página:

    https://<URL>/ws/infoforai.aspx

    https://<URL>/ws/infoforai.aspx?action=getcustomerdata

    Authorization: Bearer <ApiKey>

(Reemplaza <ApiKey> por la clave que te entregaremos via email.)

    curl -X POST "https://<URL>/ws/infoforai.aspx?action=getcustomerdata" \
        -H "Authorization: Bearer 1234567890" \
        -H "Content-Type: application/json" \
        -d "{"Email":"lionel.10@gmail.com"}"

Ingresa el <ApiKey> que te enviaron (pruebas o produccion) y descarga el correspondiente JSON del Postman Collection.

Permite obtener la clave de referencia (ReferenceId) y el listado de medios de pago habilitados (PaymentMethods) asociados a un correo electrónico ingresado.
Estos datos son necesarios para poder realizar una compra en el sistema.

Header de transacciónhttp

Ejemplo de entrada text

Authorization: Bearer 123456abcdef

Datos de entradahtml

Ejemplo de entrada json

{
    "Email": "lionel.10@gmail.com"
}

Datos de salida cuando la operación es exitosa json

Ejemplos de salida cuando la operación es exitosa json

{
    "ReferenceId": "%2bRisqh09q4WZyLdF4Gt5Yg89t3RA%2bXvHVNQEmTS3zJM%2fA%3d%3d",
    "Email": "lionel.10@gmail.com",
    "PaymentMethods": [ "CURRENTACCOUNT" ]
}

Datos de salida cuando la operación no es exitosa json

Ejemplos de salida cuando la operación no es exitosa json

{
    "Success": false,
    "Message": "El Email no se encuentra.",
    "ErrorCode": 1008,
    "ErrorName": "EmailNoSeEncuentra",
    "ErrorDescription": "Email No Se Encuentra"
}

4.1. Pasos a seguir

• 1 – Solicitar al área de Sistemas (o a su ejecutivo comercial) el API Key de su agencia, que es el identificador que la API utiliza para reconocer su cuenta.
• 2 - Desarrollar la programación necesaria para integración del sitio web de su empresa.
• 3 - Desarrollar la programación que procese los resultados que esta API devuelve, ya sean errores o resultados de finalización exitosa de las transacciones.
• 4 - Testing en el área de pruebas o “SandBox”
• 5 - Puesta en marcha en los servidores de producción.

Detallamos a continuación los mensajes de error más comunes

6.1. Introducción

Esta API cuenta con un área de pruebas llamada “SandBox” que permitirá realizar pruebas de transacciones en tiempo real.

6.2. Configuración requerida para realizar las pruebas

Para configurar la información necesaria en el Sandbox (área de pruebas), debe contactar con el área de sistemas (sistemas@coris.com.ar) , quiénes le ayudarán en ese proceso.

• 7.1 API
  Es una interfaz de programación de aplicaciones o API (del inglés Application Programming Interface) es el conjunto de funciones y procedimientos (o métodos, en la programación orientada a objetos) que ofrece cierta biblioteca para ser utilizado por otro software como una capa de abstracción.
• 7.2 ASP.NET
  Es un framework para aplicaciones web desarrollado y comercializado por Microsoft. Es usado por programadores para construir sitios web dinámicos, aplicaciones web y servicios web XML. Apareció en enero de 2002 con la versión 1.0 del .NET Framework, y es la tecnología sucesora de la tecnología Active Server Pages (ASP). ASP.NET esta construido sobre el Common Language Runtime, permitiendo a los programadores escribir código ASP.NET usando cualquier lenguaje admitido por el .NET Framework.
• 7.3 HTTP
  Hypertext Transfer Protocol o HTTP (en español protocolo de transferencia de hipertexto) es el protocolo usado en cada transacción de la World Wide Web. HTTP fue desarrollado por el World Wide Web Consortium y la Internet Engineering Task Force, colaboración que culminó en 1999.
• 7.4 JAVA
  Java es un lenguaje de programación orientado a objetos desarrollado por Sun Microsystems a principios de los años 90. El lenguaje en sí mismo toma mucha de su sintaxis de C y C++, pero tiene un modelo de objetos más simple y elimina herramientas de bajo nivel, que suelen inducir a muchos errores, como la manipulación directa de punteros o memoria.
• 7.5 Métodos POST y GET
  Son métodos de envío de información en formularios HTML. Ambos métodos, POST y GET, realizan una transacción mediante el protocolo HTTP, la diferencia radica en que el primer método envía los parámetros ocultos, mientras que el segundo los muestra en la barra de navegación.
• 7.6 PHP
  PHP es un acrónimo recursivo que significa PHP Hypertext Pre-processor. Es un lenguaje de programación interpretado, diseñado originalmente para la creación de páginas web dinámicas. Es usado principalmente en interpretación del lado del servidor (server-side scripting).
• 7.7 Sitio Web
  Un portal de Internet o portal web es un sitio web cuya característica fundamental es la de servir de Puerta de entrada (única) para ofrecer al usuario, de forma fácil e integrada, el acceso a una serie de recursos y de servicios relacionados a un mismo tema. Incluye: enlaces, buscadores, foros, documentos, aplicaciones, compra electrónica, etc. Principalmente un portal en Internet está dirigido a resolver necesidades de información específica de un tema en particular.
• 7.8 Sandbox
  Plabra que del inglés significa caja de arena («Sand»+«box»), y se refiere a un entorno de pruebas (en el contexto de desarrollo de software o desarrollo web), que aísla los cambios en el código, fruto de la experimentación, del propio entorno de producción o entorno de edición.
• 7.9 UTF-8
  Se describe como 8-bit Unicode Transformation Format. Es un formato de codificación de caracteres Unicode e ISO 10646 utilizando símbolos de longitud variable. UTF-8 fue creado por Robert C. Pike y Kenneth L. Thompson. Está definido como estándar por la RFC 3629 de la Internet Engineering Task Force (IETF).1 Actualmente es una de las tres posibilidades de codificación reconocidas por Unicode y lenguajes web, o cuatro en ISO 10646.
• 7.10 Voucher
  Documento impreso o electrónico (generalmente en PDF) donde se encuentran los datos del pasajero, la asistencia en viaje contratada y su vigencia, así como también las condiciones generales de uso. Pueden eventualmente incluir precios totales, descuentos y/o impuestos. Es utilizado para dejar constancia por parte de una empresa de que fue lo que el cliente exactamente compró o reservó.
• 7.11 SOAP
  Es un protocolo que permite la comunicación entre aplicaciones a través de mensajes por medio de Internet. Es independiente de la plataforma, y del lenguaje. Está basado en XML y es la base principal de los Web Services.
• 7.12 Escalabilidad
  Es la propiedad deseable de un sistema, una red o un proceso, que indica su habilidad para extender el margen de operaciones sin perder calidad, o bien manejar el crecimiento continuo de trabajo de manera fluida, o bien para estar preparado para hacerse más grande sin perder calidad en los servicios ofrecidos.
• 7.13 API
  Una API (del inglés Application Programming Interface, o Interfaz de Programación de Aplicaciones) es un conjunto de reglas, protocolos y herramientas que permiten que dos programas o sistemas distintos se comuniquen entre sí.