|
|
| Línea 1: |
Línea 1: |
| − | = Introducción = | + | = Autologin = |
| | | | |
| − | El Web Service permite al cliente conectarse de manera transparente a la aplicación a través de un conjunto de funciones que pueden ser llamadas desde las páginas web de sus sitios.
| + | Las plataformas Price Surfer y Price Navigator ofrecen a nuestros clientes la posibilidad de integrar nuestros productos a sus portales a través de una funcionalidad denominada “autologin”. |
| | | | |
| − | A través del servicio web un mayorista podrá buscar reservas de hoteles, aéreos o paquetes; solicitar información detallada de reservas, cambiar el estado del pago de reservas y consultar información de agencias. Todo a través de una interfaz única basada en el intercambio de documentos XML, que será descripta en esta guía de uso.
| + | Este mecanismo es empleado por varios clientes para manejar la operatoria (o al menos parte de ella) directamente en sus portales embebiendo algunas secciones de nuestras plataformas. |
| | | | |
| − | Además de este manual, están disponibles los esquemas XML (.XSD) para validar los mensajes antes de ser enviados al Web Service, así como también mensajes XML de ejemplo para cada función.
| + | A partir del 31 de Marzo del 2023, ampliando nuestras políticas de ciberseguridad, se introducen 2 cambios principales: |
| | | | |
| | + | La API espera ahora un token de usuario en lugar de usuario/contraseña. El token de usuario es un código que identifica unívocamente a un usuario y que se empleará para identificar al mismo |
| | + | Validación de la integridad de la petición empleando el protocolo HMAC (hash-based message authentication code). El protocolo lo empleamos a su vez para asignar validez temporal a una petición. |
| | | | |
| − | == Interfaz Cliente Simplificada ==
| |
| | | | |
| − | El API va a usar protocolos HTTP estandard. Lo único que se requiere es un pedido de POST del HTTP.
| + | = Autenticación por token de usuario = |
| | | | |
| − | Esto le otorgará las siguientes ventajas:
| + | El cliente de autologin deberá almacenar en su sistema el token identificatorio para cada usuario, de manera análoga a como hoy almacena usuario/contraseña y deberá emplear dicho dato para autenticarse contra nuestra plataforma. |
| | | | |
| − | * Protocolos estandards de su empresa
| + | Siguiendo el ejemplo de la sección anterior, la firma quedaría de la siguiente manera: |
| − | * No se requiere de ningún componente adicional
| |
| | | | |
| | + | http://{cliente-base-url}.app.pricenavigator.net/security/autologin.html?apiKey={userToken} |
| | | | |
| − | == Requisitos de los clientes ==
| + | Para facilitar la implementación de este cambio, se incorporó en la exportación de usuarios de nuestro backoffice administrativo este dato. |
| | | | |
| − | * Los pedidos de los clientes deben ser hechos desde una dirección pública y estática que esté registrada con NEMO.
| + | = Validación de petición a través de HMAC = |
| − | * Los pedidos del cliente deben ser hechos a través de un pedido POST de HTTP.
| |
| − | * Toda la información enviada y recibida a través de la interface va a ser guardada en UTF-8
| |
| | | | |
| | + | El protocolo HMAC(hash-based message authentication code) estipula el envío de un código generado a partir de cierta información de la petición, un algoritmo criptográfico y una clave secreta (compartida en este caso por Nemo y el cliente). |
| | | | |
| − | == Autenticación del Cliente ==
| |
| | | | |
| − | Los headers del POST deben contener autenticación HTTP de tipo basic estandar, con nombre y usuario habilitado de Navigator (las mismas credenciales que se usan para ingresar en el backend).
| + | = Cambios del lado del cliente: = |
| | | | |
| | + | Para emplear esta funcionalidad el cliente deberá seguir los siguientes pasos: |
| | | | |
| − | == Acceso ==
| + | Solicitar el alta de la funcionalidad a Nemo. |
| | + | Nemo le proporcionará la clave secreta que empleará para generar el código de validación. |
| | + | El cliente deberá enviar 2 parámetros adicionales en su petición: |
| | | | |
| | + | timestamp . Marca de tiempo de la petición en el formato especificado en RFC 2616: Hypertext Transfer Protocol — HTTP/1.1 (primer formato). |
| | + | signature. Código de autenticación generado por la función de hasheo SHA256 a partir de la clave secreta y la marca de tiempo indicada en el campo anterior. |
| | + | SHA256(clientSecretKey, timestamp) = signature |
| | | | |
| − | URL del servicio = <span style="color: red">API URL</span> + <span style="color: green">nombre del mensaje</span>
| + | La firma y la marca de tiempo deberán generarse para cada petición de autologin ya que tienen una validez temporal. |
| | | | |
| | + | Si la marca de tiempo está expirada o la firma no se corresponde con dicha marca de tiempo y la clave secreta del cliente se rechazará la petición de autenticación. |
| | | | |
| − | '''API URL (según entorno):'''
| + | Siguiendo el ejemplo anterior, la petición de autenticación quedaría así: |
| − | * Entorno de Test: <nowiki>http://certnav.psurfer.net/backend.php/api/</nowiki>
| |
| − | * Entorno de producción: <nowiki>http://<dominio>/backend.php/api/</nowiki>
| |
| | | | |
| | + | http://{cliente-base-url}.app.pricenavigator.net/security/autologin.html?apiKey={userToken}×tamp={timestamp}&signature={signature} |
| | | | |
| − | '''Nombre del mensaje:'''
| + | Para ponerlo en valores de ejemplo |
| − | * ''BookingsQueryRQ'' : Búsqueda de reservas
| |
| − | * ''BookingsDetailsRQ'' : Pedido de detalle de reservas
| |
| − | * ''AgencyQueryRQ'' : Pedido de detalle de agencias
| |
| − | * ''BookingPaymentStatusRQ'' : Cambio de estado de reserva a pagado
| |
| | | | |
| | + | clientSecretKey = qY8NxIDIjtVPWxsT |
| | | | |
| − | Ejemplo de pedido de reservas al servidor de test:
| + | timestamp = Thu, 29 Dec 2022 18:06:37 GMT |
| − | http://certnav.psurfer.net/backend.php/api/BookingsQueryRQ
| |
| | | | |
| | + | signature = f9f202bab9de55953a714ec69f218fd774d4433449a9f4ae09727362d623925d |
| | | | |
| − | '''El POST debe llevar adjunto un archivo XML con igual nombre al mensaje (BookingsQueryRQ.xml) cuyo contenido será el de la consulta que se quiere hacer al WebService.''' Para ver un ejemplo: [[Price_Surfer_-_Export_contable#BookingsQueryRQ|BookingsQueryRQ]]
| + | Nemo proveerá la clave secreta al cliente una vez que se habilite la funcionalidad. |
| | | | |
| − | == Ejemplos de acceso == | + | = Recursos = |
| | | | |
| − | Script Bash
| + | Colección Postman con ejemplos: https://api.postman.com/collections/1129077-e69b96e6-4c0e-4cef-8201-ca2bc9372a0b?access_key=PMAT-01GNHEXG4R9CDM3J62F6R5Q4QQ |
| − | <code lang="bash">
| |
| − | #!/bin/sh
| |
| | | | |
| − | URL='http://certnav.psurfer.net/backend.php/api/BookingsQueryRQ'
| + | HMAC Generator Online Tool: https://www.freeformatter.com/hmac-generator.html |
| | | | |
| − | # credenciales
| + | Cualquier inquietud, podés escribirnos a support@nemogroup.net |
| − | USER=nombreDeUsuario
| |
| − | PASS=password
| |
| − | | |
| − | # path del archivo RQ
| |
| − | FILE='/ruta/al/archivo/BookingsQueryRQ.xml'
| |
| − | | |
| − | # POST
| |
| − | curl -u $USER:$PASS -X POST -F 'BookingsQueryYcixRQ=@'$FILE $URL
| |
| − | </Code>
| |
| − | | |
| − | PHP
| |
| − | <code lang="php">
| |
| − | <?php
| |
| − | | |
| − | $backend_url = 'http://certnav.psurfer.net/backend.php/api/BookingsQueryRQ';
| |
| − | $login = 'nombreDeUsuario';
| |
| − | $password = 'password';
| |
| − | $file_path = '/ruta/al/archivo/BookingsQueryRQ.xml';
| |
| − | | |
| − | $post = array('BookingsQueryRQ' => '@' . $file_path);
| |
| − | | |
| − | $ch = curl_init();
| |
| − | curl_setopt($ch, CURLOPT_URL, $backend_url);
| |
| − | curl_setopt($ch, CURLOPT_POST, 1);
| |
| − | curl_setopt($ch, CURLOPT_HEADER, 1);
| |
| − | curl_setopt($ch, CURLOPT_USERPWD, $login . ":" . $password);
| |
| − | curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
| |
| − | $result = curl_exec($ch);
| |
| − | curl_close($ch);
| |
| − | | |
| − | ?>
| |
| − | </Code>
| |
| − | | |
| − | Para ver un ejemplo del archivo de consulta [[Price_Surfer_-_Export_contable#BookingsQueryRQ|BookingsQueryRQ]]
| |
| − | | |
| − | == Códigos de respuesta de la petición HTTP ==
| |
| − | | |
| − | La respuesta del WebService puede tomar diferentes códigos, a continuación se detalla el significado de cada una.
| |
| − | | |
| − | | |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | ! Código !! Respuesta
| |
| − | |-
| |
| − | | 200 || OK
| |
| − | |-
| |
| − | | 400 || No valida el XML de la consulta
| |
| − | |-
| |
| − | | 401 || Fallo de autenticación
| |
| − | |-
| |
| − | | 404 || No se encontró el archivo XML de la consulta
| |
| − | |-
| |
| − | | 404 || No se encontraron agencias con los parámetros de búsqueda ingresados
| |
| − | |-
| |
| − | | 404 || No se encontraron reservas con los parámetros de búsqueda ingresados
| |
| − | |-
| |
| − | | 503 || Error interno
| |
| − | |}
| |
| − | | |
| − | | |
| − | Por cualquier consulta recuerde dirigirse al mail de Soporte Técnico:
| |
| − | support@pricenavigator.net | |
| − | | |
| − | = Mensajes soportados =
| |
| − | | |
| − | | |
| − | == Buscar reservas ('''BookingsQueryRQ''') ==
| |
| − | | |
| − | Búsqueda de reservas en un rango de fechas determinado. Retorna un listado de reservas correspondientes a las fechas ingresadas.
| |
| − | | |
| − | Recibe [[Price_Surfer_-_Export_contable#BookingsQueryRQ|BookingsQueryRQ]], retorna [[Price_Surfer_-_Export_contable#BookingsQueryRS|BookingsQueryRS]].
| |
| − | | |
| − | La búsqueda incluye aéreos, hoteles y paquetes.
| |
| − | | |
| − | Se pueden ingresar como parámetros para la búsqueda:
| |
| − | | |
| − | * fecha de creación
| |
| − | * fecha de checkin
| |
| − | * identificador de la agencia
| |
| − | * nombre de pasajero
| |
| − | * nombre de cliente
| |
| − | * estado de la reserva
| |
| − | * estado del item de la reserva
| |
| − | * nivel de detalle de la respuesta
| |
| − | * fecha de último cambio de estado
| |
| − | | |
| − | == Solicitar información detallada de reservas ('''BookingsDetailsRQ''') ==
| |
| − | | |
| − | Consulta de información detallada de una reserva determinada especificando un identificador de la reserva.
| |
| − | | |
| − | | |
| − | Recibe [[Price_Surfer_-_Export_contable#BookingsDetailsRQ|BookingsDetailsRQ]], retorna [[Price_Surfer_-_Export_contable#BookingsDetailsRS|BookingsDetailsRS]].
| |
| − | | |
| − | | |
| − | == Cambiar estado del pago de reservas ('''BookingPaymentStatusRQ''') ==
| |
| − | | |
| − | Cambio de estado de pago de una reserva. Retorna el resultado de la transacción. Podrá indicar si el cambio fue realizado con éxito o en caso contrario notificar qué evento se produjo por el cual no pudo realizarse el cambio.
| |
| − | | |
| − | | |
| − | Recibe [[Price_Surfer_-_Export_contable#BookingPaymentStatusRQ|BookingPaymentStatusRQ]], retorna [[Price_Surfer_-_Export_contable#BookingPaymentStatusRS|BookingPaymentStatusRS]].
| |
| − | | |
| − | | |
| − | == Consultar info de agencia ('''AgencyQueryRQ''') ==
| |
| − | | |
| − | Consulta de información detallada de una agencia determinada especificando el ID de agencia o el nombre de la misma.
| |
| − | | |
| − | | |
| − | Recibe [[Price_Surfer_-_Export_contable#AgencyQueryRQ|AgencyQueryRQ]], retorna [[Price_Surfer_-_Export_contable#AgencyQueryRS|AgencyQueryRS]].
| |
| − | | |
| − | = Documentos XML =
| |
| − | | |
| − | | |
| − | == Mensaje BookingsQuery: Buscar reservas ==
| |
| − | | |
| − | La búsqueda de reservas permite obtener un listado de reservas con toda la información referida a cada reserva en particular.
| |
| − | | |
| − | El método BookingsQuery recibe un documento BookingsQueryRQ y retorna un documento BookingsQueryRS.
| |
| − | | |
| − | | |
| − | === BookingsQueryRQ ===
| |
| − | | |
| − | Ejemplo
| |
| − | | |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <?xml version="1.0" encoding="UTF-8"?>
| |
| − | <BookingsQueryRQ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:noNamespaceSchemaLocation='AEXCEV_Main.xsd'>
| |
| − | <GeneralParameters>
| |
| − | <PreferedLanguage LanguageCode="es-AR"/>
| |
| − | </GeneralParameters>
| |
| − | <Details>
| |
| − | <Criterion>
| |
| − | <AgencyId>12113</AgencyId>
| |
| − | <CreationDate>
| |
| − | <DateFrom>2013-11-03</DateFrom>
| |
| − | <DateTo>2013-11-05</DateTo>
| |
| − | </CreationDate>
| |
| − | <CheckinDate>
| |
| − | <DateFrom>2013-11-20</DateFrom>
| |
| − | <DateTo>2013-11-22</DateTo>
| |
| − | </CheckinDate>
| |
| − | <GuestName>JUANA PEREZ</GuestName>
| |
| − | <ClientName>juan perez</ClientName>
| |
| − | <BookingState>
| |
| − | <Code>NMO.GBL.BST.CNF</Code>
| |
| − | </BookingState>
| |
| − | <BookingItemState>
| |
| − | <Code>NMO.HTL.BST.CNF</Code>
| |
| − | </BookingItemState>
| |
| − | <DetailLevel>full</DetailLevel>
| |
| − | <LastChangeDate>
| |
| − | <DateFrom>2013-11-04</DateFrom>
| |
| − | <DateTo>2013-11-04</DateTo>
| |
| − | </LastChangeDate>
| |
| − | </Criterion>
| |
| − | </Details>
| |
| − | </BookingsQueryRQ>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | ! Parámetro !! Obligatorio !! Descripción
| |
| − | |-
| |
| − | | GeneralParameters || '''Si''' || Parámetros generales de configuración de la consulta
| |
| − | |-
| |
| − | | PreferedLanguage || '''Si''' || Establece el lenguaje requerido para la respuesta
| |
| − | Atributos:
| |
| − | LanguageCode: Código de lenguaje correspondiente a los códigos de lenguaje estándar provistos por Web Services
| |
| − | |-
| |
| − | | Details || '''Si''' || Detalle del mensaje de búsqueda
| |
| − | |-
| |
| − | | Criterion || '''Si''' || Indica los distintos parámetros de la búsqueda
| |
| − | |-
| |
| − | | AgencyId || No || Indica el número de agencia para buscar
| |
| − | |-
| |
| − | | CreationDate || No || Indica el rango de fechas de creación de la reserva
| |
| − | |-
| |
| − | | DateFrom || No || Fecha de creación desde
| |
| − | |-
| |
| − | | DateTo || No || Fecha de creación hasta
| |
| − | |-
| |
| − | | CheckinDate || No || Indica el rango de las fechas de checkin de la reserva
| |
| − | |-
| |
| − | | DateFrom || No || Fecha de checkin desde
| |
| − | |-
| |
| − | | DateTo || No || Fecha de checkin hasta
| |
| − | |-
| |
| − | | GuestName || No || Identifica el nombre del huésped para la habitación
| |
| − | |-
| |
| − | | ClientName || No || Persona que realiza la reserva
| |
| − | |-
| |
| − | | BookingState || No || Estado de la reserva
| |
| − | |-
| |
| − | | Code || No || Código de estado de la reserva
| |
| − | |-
| |
| − | | BookingItemState || No || Estado del item de reserva
| |
| − | |-
| |
| − | | Code || No || Código de estado del item de la reserva
| |
| − | |-
| |
| − | | DetailLevel || No || Indica el nivel de detalle de la respuesta. Opciones 'BASIC' y 'FULL'
| |
| − | |-
| |
| − | | LastChangeDate || No || Indica el rango de fechas del último cambio de estado de la reserva
| |
| − | |-
| |
| − | | DateFrom || No || Fecha del último cambio de estado de la reserva desde
| |
| − | |-
| |
| − | | DateTo || No || Fecha del último cambio de estado de la reserva hasta
| |
| − | |}
| |
| − | | |
| − | === BookingsQueryRS ===
| |
| − | | |
| − | Ejemplo
| |
| − | | |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <?xml version="1.0" encoding="UTF-8"?>
| |
| − | <BookingsQueryRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="AEXCEV_Main.xsd">
| |
| − | <Echo>
| |
| − | <GeneralParameters>
| |
| − | <PreferedLanguage LanguageCode="es-AR" />
| |
| − | </GeneralParameters>
| |
| − | <Details>
| |
| − | <Criterion>
| |
| − | <AgencyId>11539</AgencyId>
| |
| − | <CreationDate>
| |
| − | <DateFrom>2011-06-23</DateFrom>
| |
| − | <DateTo>2011-06-24</DateTo>
| |
| − | </CreationDate>
| |
| − | <CheckinDate>
| |
| − | <DateFrom>2011-07-19</DateFrom>
| |
| − | <DateTo>2011-07-19</DateTo>
| |
| − | </CheckinDate>
| |
| − | <GuestName>John0</GuestName>
| |
| − | <ClientName>Cesar Palmieri</ClientName>
| |
| − | </Criterion>
| |
| − | </Details>
| |
| − | </Echo>
| |
| − | <Details>
| |
| − | <Bookings ItemsCount="1">
| |
| − | <Booking Sequence="1" ContractId="11640" AgencyId="11539">
| |
| − | <BookingReference ReferenceType="NMO.GBL.BRT.NAV">DN_0000Y</BookingReference>
| |
| − | <BookingState ItemsCount="1">
| |
| − | <BookingState>
| |
| − | <Code>NMO.HTL.BST.RQF</Code>
| |
| − | <Description>Request failed</Description>
| |
| − | <StateMachineId>2</StateMachineId>
| |
| − | <StateDateTime>2011-11-16T09:57:44</StateDateTime>
| |
| − | </BookingState>
| |
| − | </BookingState>
| |
| − | <BookingCreationDate>2011-06-23</BookingCreationDate>
| |
| − | <ClientName>cesar palmieri</ClientName>
| |
| − | <Price PriceType="PVP">
| |
| − | <Amount CurrencyCode="USD">0</Amount>
| |
| − | </Price>
| |
| − | <BookingItems>
| |
| − | <Hotels ItemsCount="1">
| |
| − | <Hotel Sequence="1">
| |
| − | <BookingReference ReferenceType="NMO.HTL.RPT.MPH">DN_0000Y-1</BookingReference>
| |
| − | </Hotel>
| |
| − | </Hotels>
| |
| − | </BookingItems>
| |
| − | </Booking>
| |
| − | </Bookings>
| |
| − | </Details>
| |
| − | </BookingsQueryRS>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | | |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | ! Parámetro !! Obligatorio !! Descripción
| |
| − | |-
| |
| − | | GeneralParameters || SI || Parámetros generales de configuración de la consulta.
| |
| − | |-
| |
| − | | PreferedLanguage || SI || Establece el lenguaje requerido para la respuesta.
| |
| − | Atributos:
| |
| − | LanguageCode: Código de lenguaje correspondiente a los códigos de lenguaje estándar provistos por Web Services.
| |
| − | |-
| |
| − | | Details || SI || Detalle de la respuesta del mensaje de búsqueda.
| |
| − | |-
| |
| − | | Criterion || SI || Indica los distintos parámetros de la búsqueda.
| |
| − | |-
| |
| − | | AgencyId || NO || Indica el número de agencia para buscar.
| |
| − | |-
| |
| − | | CreationDate || NO || Indica el rango de las fechas de creación de la reserva.
| |
| − | |-
| |
| − | | DateFrom || NO || Fecha de creación desde.
| |
| − | |-
| |
| − | | DateTo || NO || Fecha de creación hasta.
| |
| − | |-
| |
| − | | CheckinDate || NO || Indica el rango de las fechas de checkin de la reserva.
| |
| − | |-
| |
| − | | DateFrom || NO || Fecha de checkin desde.
| |
| − | |-
| |
| − | | DateTo || NO || Fecha de checkin hasta.
| |
| − | |-
| |
| − | | GuestName || NO || Identifica el nombre del huésped para la habitación.
| |
| − | |-
| |
| − | | ClientName || NO || Persona que realiza la reserva.
| |
| − | |-
| |
| − | | Bookings || SI || Detalle de las reservas encontradas.
| |
| − | |-
| |
| − | | BookingReference || SI || Lista de referencias asociadas a la reserva.
| |
| − | |-
| |
| − | | BookingState || SI || Estado de la reserva.
| |
| − | |-
| |
| − | | Code || SI || Código de estado de la reserva.
| |
| − | |-
| |
| − | | Description || SI || Descripción del estado de la reserva.
| |
| − | |-
| |
| − | | StateMachineId || SI || Id de la máquina de estados.
| |
| − | |-
| |
| − | | StateDateTime || SI || Fecha del cambio de estado.
| |
| − | |-
| |
| − | | BookingCreationDate || SI || Fecha de creación de la reserva.
| |
| − | |-
| |
| − | | ClientName || SI || Nombre del cliente que realizó la reserva.
| |
| − | |-
| |
| − | | Price || SI || Precio y tipo de precio de la reserva.
| |
| − | |-
| |
| − | | Amount || SI || Monto del precio de la reserva.
| |
| − | |-
| |
| − | | BookingItems || SI || Detalle de los items de la reserva.
| |
| − | |-
| |
| − | | Hotels || SI || Items de hoteles.
| |
| − | |-
| |
| − | | BookingReference || SI || Lista de referencias asociadas a la reserva.
| |
| − | |}
| |
| − | | |
| − | == Mensaje BookingsDetails: Solicitar información detallada de reservas ==
| |
| − | | |
| − | La solicitud de información detallada de reservas permite obtener detalles de los datos por cada reserva.
| |
| − | | |
| − | El método BookingsDetails recibe un documento BookingsDetailsRQ y retorna un documento BookingsDetailsRS.
| |
| − | | |
| − | | |
| − | === BookingsDetailsRQ ===
| |
| − | | |
| − | Ejemplo
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <?xml version="1.0" encoding="UTF-8"?>
| |
| − | <BookingsDetailsRQ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:noNamespaceSchemaLocation='AEXCEV_Main.xsd'>
| |
| − | <GeneralParameters>
| |
| − | <PreferedLanguage LanguageCode="es-AR"/>
| |
| − | </GeneralParameters>
| |
| − | <Details>
| |
| − | <Bookings ItemsCount="1">
| |
| − | <Booking Sequence="1">
| |
| − | <BookingReference ReferenceType="NMO.GBL.BRT.NAV">QN_00787</BookingReference>
| |
| − | </Booking>
| |
| − | </Bookings>
| |
| − | </Details>
| |
| − | </BookingsDetailsRQ>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | | |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | ! Parámetro !!Obligatorio !! Descripción
| |
| − | |-
| |
| − | | GeneralParameters || '''Si''' || Parámetros generales de configuración de la consulta.
| |
| − | |-
| |
| − | | PreferedLanguage || '''Si''' || Establece el lenguaje requerido para la respuesta.
| |
| − | Atributos:
| |
| − | LanguageCode: Código de lenguaje correspondiente a los códigos de lenguaje estándar provistos por Web Services.
| |
| − | |-
| |
| − | | Details || '''Si''' || Detalle del mensaje de pedido de reservas.
| |
| − | |-
| |
| − | | Bookings || '''Si''' || Reservas pedidas.
| |
| − | |-
| |
| − | | BookingReference || '''Si''' || Lista de referencias asociadas a la reserva.
| |
| − | |}
| |
| − | | |
| − | === BookingsDetailsRS ===
| |
| − | | |
| − | Ejemplo
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <?xml version="1.0" encoding="UTF-8"?>
| |
| − | <BookingsDetailsRS xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:noNamespaceSchemaLocation='AEXCEV_Main.xsd'>
| |
| − | <Echo>
| |
| − | <GeneralParameters>
| |
| − | <PreferedLanguage LanguageCode="es-AR"/>
| |
| − | </GeneralParameters>
| |
| − | <Details>
| |
| − | <Bookings ItemsCount="1">
| |
| − | <Booking Sequence="1">
| |
| − | <BookingReference ReferenceType="NMO.GLB.BRT.NAV">QN_00787</BookingReference>
| |
| − | </Booking>
| |
| − | </Bookings>
| |
| − | </Details>
| |
| − | </Echo>
| |
| − | <Details>
| |
| − | <Bookings ItemsCount="1">
| |
| − | <Booking Sequence="1" ContractId="12221">
| |
| − | <BookingReferences ItemsCount="1">
| |
| − | <BookingReference ReferenceType="NMO.GBL.BRT.NAV">QN_00787</BookingReference>
| |
| − | </BookingReferences>
| |
| − | <BookingCreationDate>2013-11-20T19:19:52</BookingCreationDate>
| |
| − | <ClientName>Ana Gomez</ClientName>
| |
| − | <Agency AgencyId="12113">
| |
| − | <Name>Operador Veronica</Name>
| |
| − | <CreationUser>ADMINISTRADOR NEMO PRODUCCION</CreationUser>
| |
| − | </Agency>
| |
| − | <User UserId="16035">
| |
| − | <Name>Veronica Vergara</Name>
| |
| − | <Login>veronica.vergara</Login>
| |
| − | </User>
| |
| − | <BookingState ItemsCount="1">
| |
| − | <BookingState>
| |
| − | <Code>NMO.GBL.BST.CNF</Code>
| |
| − | <Description>Confirmado</Description>
| |
| − | <StateDateTime>2013-11-21T14:00:52</StateDateTime>
| |
| − | </BookingState>
| |
| − | </BookingState>
| |
| − | <Payments ItemsCount="1">
| |
| − | <Payment Sequence="1" Type="NMO.CTR.WKF.CAC">
| |
| − | <Amount CurrencyCode="USD">384.10</Amount>
| |
| − | </Payment>
| |
| − | </Payments>
| |
| − | <BookingItems>
| |
| − | <Hotels ItemsCount="1">
| |
| − | <Hotel Sequence="1" HotelId="120470" Name="Aida" SupplierID="BOL">
| |
| − | <BookingReferences ItemsCount="3">
| |
| − | <BookingReference Sequence="1" ReferenceType="NMO.HTL.RPT.MPH">QN_00787-1</BookingReference>
| |
| − | <BookingReference Sequence="2" ReferenceType="NMO.HTL.RPT.PRS.PS1">102</BookingReference>
| |
| − | <BookingReference Sequence="3" ReferenceType="NMO.HTL.RPT.PRS.PS2">4027242</BookingReference>
| |
| − | </BookingReferences>
| |
| − | <DestinationDetails ItemsCount="2">
| |
| − | <Destination Sequence="1" DestinationType="NMO.HTL.DST.CTR" DestinationCode="139">España</Destination>
| |
| − | <Destination Sequence="2" DestinationType="NMO.HTL.DST.CTY" DestinationCode="2262">Madrid</Destination>
| |
| − | </DestinationDetails>
| |
| − | <CheckIn>2013-12-17</CheckIn>
| |
| − | <CheckOut>2013-12-18</CheckOut>
| |
| − | <Deadline>2013-12-16</Deadline>
| |
| − | <Boards ItemsCount="1">
| |
| − | <Board Sequence="1" BoardCode="14">Solo habitacion</Board>
| |
| − | </Boards>
| |
| − | <Passengers ItemsCount="3">
| |
| − | <Passenger Sequence="1" AgeType="NMO.GBL.AGT.ADT" Identifier="30456789" CountryOfResidence="arg" Nationality="Argentino">ANA GOMEZ</Passenger>
| |
| − | <Passenger Sequence="2" AgeType="NMO.GBL.AGT.ADT" Identifier="30456321" CountryOfResidence="klñ" Nationality="Argentino">ANAS GOMEZ</Passenger>
| |
| − | <Passenger Sequence="3" AgeType="NMO.GBL.AGT.CHD" Identifier="304564654" CountryOfResidence="hghg" Nationality="Argentino">ANAD GOMEZ</Passenger>
| |
| − | </Passengers>
| |
| − | <Rooms ItemsCount="1">
| |
| − | <Room Sequence="1" RoomType="NMO.HTL.RMT.DBL">Doble</Room>
| |
| − | </Rooms>
| |
| − | <Description>Aida checkin 2013-12-17 checkout 2013-12-18, 1 Doble</Description>
| |
| − | <BookingStates ItemsCount="1">
| |
| − | <BookingState>
| |
| − | <Code>NMO.HTL.BST.CNF</Code>
| |
| − | <Description>Confirmado</Description>
| |
| − | <StateDateTime>2013-11-20T19:19:55</StateDateTime>
| |
| − | </BookingState>
| |
| − | </BookingStates>
| |
| − | <Prices ItemsCount="3">
| |
| − | <Price PriceType="NMO.GBL.RPT.GRS" Sequence="1">
| |
| − | <Amount CurrencyCode="USD">384.10</Amount>
| |
| − | </Price>
| |
| − | <Price PriceType="NMO.HTL.RPT.NET" Sequence="2">
| |
| − | <Amount CurrencyCode="USD">47.21</Amount>
| |
| − | </Price>
| |
| − | <Price PriceType="NMO.HTL.RPT.AFP" Sequence="3">
| |
| − | <Amount CurrencyCode="USD">9.44</Amount>
| |
| − | </Price>
| |
| − | </Prices>
| |
| − | </Hotel>
| |
| − | </Hotels>
| |
| − | </BookingItems>
| |
| − | </Booking>
| |
| − | </Bookings>
| |
| − | </Details>
| |
| − | </BookingsDetailsRS>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | | |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | ! Parámetro !! Obligatorio !! Descripción
| |
| − | |-
| |
| − | | GeneralParameters || '''Si''' || Parámetros generales de configuración de la consulta.
| |
| − | |-
| |
| − | | PreferedLanguage || '''Si''' || Establece el lenguaje requerido para la respuesta.
| |
| − | Atributos:
| |
| − | LanguageCode: Código de lenguaje correspondiente a los códigos de lenguaje estándar provistos por Web Services.
| |
| − | |-
| |
| − | | Details || '''Si''' || Detalle de la consulta de reservas.
| |
| − | |-
| |
| − | | Bookings || '''Si''' || Reservas de la consulta.
| |
| − | |-
| |
| − | | BookingReference || '''Si''' || Lista de referencias asociadas a la reserva que se consulta.
| |
| − | |-
| |
| − | | Details || '''Si''' || Detalle de la respuesta al mensaje de pedido de reservas.
| |
| − | |-
| |
| − | | Bookings || '''Si''' || Detalle de las reservas encontradas.
| |
| − | |-
| |
| − | | BookingReference || '''Si''' || Lista de referencias asociadas a la reserva.
| |
| − | |-
| |
| − | | BookingCreationDate || '''Si''' || Fecha de creación de la reserva.
| |
| − | |-
| |
| − | | ClientName || '''Si''' || Nombre del cliente de la reserva.
| |
| − | |-
| |
| − | | Agency || '''Si''' || Agencia que realizó la reserva.
| |
| − | |-
| |
| − | | Name || '''Si''' || Nombre de la agencia que realizó la reserva.
| |
| − | |-
| |
| − | | CreationUser || '''Si''' || Usuario de la agencia que realizó la reserva.
| |
| − | |-
| |
| − | | User || '''Si''' || Usuario que realizó la reserva.
| |
| − | |-
| |
| − | | Name || '''Si''' || Nombre del usuario que realizó la reserva.
| |
| − | |-
| |
| − | | Login || '''Si''' || Login del usuario que realizó la reserva.
| |
| − | |-
| |
| − | | BookingState || '''Si''' || Estado de la reserva.
| |
| − | |-
| |
| − | | Code || '''Si''' || Código de estado de la reserva.
| |
| − | |-
| |
| − | | Description || '''Si''' || Descripción del estado de la reserva.
| |
| − | |-
| |
| − | | StateDateTime || '''Si''' || Fecha y hora del cambio de estado de la reserva.
| |
| − | |-
| |
| − | | Payments || No || Pagos efectuados de la reserva.
| |
| − | |-
| |
| − | | Amount || No || Monto del pago efectuado por la reserva.
| |
| − | |-
| |
| − | | BookingItems || '''Si''' || Detalle de los items de la reserva.
| |
| − | |-
| |
| − | | Hotels || '''Si''' || Detalle de los items de hoteles de la reserva.
| |
| − | |-
| |
| − | | BookingReferences || '''Si''' || Lista de referencias asociadas al item de la reserva.
| |
| − | |-
| |
| − | | DestinationDetails || '''Si''' || Destino del item de la reserva.
| |
| − | |-
| |
| − | | Destination || '''Si''' || Detalle del destino del item de la reserva.
| |
| − | |-
| |
| − | | CheckIn || '''Si''' || Fecha de checkin del item de la reserva.
| |
| − | |-
| |
| − | | CheckOut || '''Si''' || Fecha de checkout del item de la reserva.
| |
| − | |-
| |
| − | | Boards || '''Si''' || Regimenes del item de la reserva.
| |
| − | |-
| |
| − | | Passengers || '''Si''' || Pasajeros del item de la reserva.
| |
| − | |-
| |
| − | | Rooms || '''Si''' || Habitaciones del item de la reserva.
| |
| − | |-
| |
| − | | Description || '''Si''' || Descripción del item de la reserva.
| |
| − | |-
| |
| − | | BookingStates || '''Si''' || Estados del item de la reserva.
| |
| − | |-
| |
| − | | Code || '''Si''' || Código de estado del item de la reserva.
| |
| − | |-
| |
| − | | Description || '''Si''' || Descripción del estado del item de la reserva.
| |
| − | |-
| |
| − | | StateDateTime || '''Si''' || Fecha y hora del cambio de estado del item de la reserva.
| |
| − | |-
| |
| − | | Prices || '''Si''' || Precios del item de la reserva.
| |
| − | |-
| |
| − | | Amount || '''Si''' || Monto del precio del item de la reserva.
| |
| − | |}
| |
| − | | |
| − | | |
| − | ==== Resolución AFIP 3450 ====
| |
| − | | |
| − | El impuesto para destinos internacionales se muestra en la sección de precios con el código "NMO.HTL.RPT.AFP":
| |
| − | | |
| − | <Code lang="xml">
| |
| − | <Prices ItemsCount="3">
| |
| − | <Price PriceType="NMO.GBL.RPT.GRS" Sequence="1">
| |
| − | <Amount CurrencyCode="USD">384.10</Amount>
| |
| − | </Price>
| |
| − | <Price PriceType="NMO.HTL.RPT.NET" Sequence="2">
| |
| − | <Amount CurrencyCode="USD">47.21</Amount>
| |
| − | </Price>
| |
| − | <Price PriceType="NMO.HTL.RPT.AFP" Sequence="3">
| |
| − | <Amount CurrencyCode="USD">9.44</Amount>
| |
| − | </Price>
| |
| − | </Prices>
| |
| − | </Code>
| |
| − | | |
| − | == Mensaje BookingPaymentStatus: Cambiar estado del pago de reservas ==
| |
| − | | |
| − | El cambio de estado del pago de reservas permite obtener el resultado de la transacción. Si éste se realizó con éxito o, caso contrario, notificar porqué no pudo realizarse.
| |
| − | | |
| − | El método BookingPaymentStatus recibe un documento BookingPaymentStatusRQ y retorna un documento BookingPaymentStatusRS.
| |
| − | | |
| − | | |
| − | === BookingPaymentStatusRQ ===
| |
| − | | |
| − | Ejemplo
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <?xml version="1.0" encoding="UTF-8"?>
| |
| − | <BookingPaymentStatusRQ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:noNamespaceSchemaLocation='AEXCEV_Main.xsd'>
| |
| − | <Details>
| |
| − | <Bookings ItemsCount="1">
| |
| − | <Booking Sequence="1">
| |
| − | <BookingReference ReferenceType="NMO.GBL.BRT.NAV">DN_0000Y</BookingReference>
| |
| − | <BookingItems>
| |
| − | <Hotels ItemsCount="1">
| |
| − | <Hotel Sequence="1">
| |
| − | <BookingReference ReferenceType="NMO.FLT.BRT.NAV">DN_0000Y-1</BookingReference>
| |
| − | </Hotel>
| |
| − | </Hotels>
| |
| − | </BookingItems>
| |
| − | </Booking>
| |
| − | </Bookings>
| |
| − | </Details>
| |
| − | </BookingPaymentStatusRQ>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | | |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | ! Parámetro !! Obligatorio !! Descripción
| |
| − | |-
| |
| − | | Details || SI || Detalle del cambio de estado en las reservas.
| |
| − | |-
| |
| − | | Bookings || SI || Reservas con pedido de cambio de estado.
| |
| − | |-
| |
| − | | BookingReference || SI || Lista de referencias asociadas a la reserva.
| |
| − | |-
| |
| − | | Hotels || NO || Detalle de los items de hoteles de la reserva.
| |
| − | |-
| |
| − | | BookingReference || SI || Lista de referencias asociadas al item de hotel de la reserva.
| |
| − | |-
| |
| − | | Flights || NO || Detalle de los items de aéreos de la reserva.
| |
| − | |-
| |
| − | | BookingReference || SI || Lista de referencias asociadas al item de aéreos de la reserva.
| |
| − | |}
| |
| − | | |
| − | === BookingPaymentStatusRS ===
| |
| − | | |
| − | Ejemplo
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <?xml version="1.0" encoding="UTF-8"?>
| |
| − | <BookingPaymentStatusRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="AEXCEV_Main.xsd">
| |
| − | <Notifications ItemsCount="1">
| |
| − | <Notification Sequence="1">
| |
| − | <NotificationId>DN_0000Y-1</NotificationId>
| |
| − | <NotificationType>Success</NotificationType>
| |
| − | <NotificationMessage>Se informó el pago del item.</NotificationMessage>
| |
| − | </Notification>
| |
| − | </Notifications>
| |
| − | </BookingPaymentStatusRS>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | | |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | ! Parámetro !! Obligatorio !! Descripción
| |
| − | |-
| |
| − | | Notifications || SI || Notificaciones del envío del mensaje.
| |
| − | |-
| |
| − | | NotificationId || SI || Id del item de la reserva que se envió el aviso de pago.
| |
| − | |-
| |
| − | | NotificationType || SI || Respuesta del envió del mensaje.
| |
| − | |-
| |
| − | | NotificationMessage || SI || Descripción de la respuesta al mensaje.
| |
| − | |}
| |
| − | | |
| − | == Mensaje AgencyQuery: Consultar info de agencia ==
| |
| − | | |
| − | La consulta de información de agencia permite obtener información detallada de una agencia en particular.
| |
| − | | |
| − | El método AgencyQuery recibe un documento AgencyQueryRQ y retorna un documento AgencyQueryRS.
| |
| − | | |
| − | | |
| − | === AgencyQueryRQ ===
| |
| − | | |
| − | Ejemplo
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <?xml version="1.0" encoding="UTF-8"?>
| |
| − | <AgencyQueryRQ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:noNamespaceSchemaLocation='AEXCEV_Main.xsd'>
| |
| − | <Details>
| |
| − | <Agencies ItemsCount="1">
| |
| − | <Agency Sequence="1" AgencyId="2">Operador Mariana Dos</Agency>
| |
| − | </Agencies>
| |
| − | </Details>
| |
| − | </AgencyQueryRQ>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | | |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | ! Parámetro !! Obligatorio !! Descripción
| |
| − | |-
| |
| − | | Details || SI || Detalle de la consulta de agencias.
| |
| − | |-
| |
| − | | Agencies || SI || Agencias de las que se quiere obtener información.
| |
| − | |}
| |
| − | | |
| − | === AgencyQueryRS ===
| |
| − | | |
| − | Ejemplo
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <?xml version="1.0" encoding="UTF-8"?>
| |
| − | <AgencyQueryRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="AEXCEV_Main.xsd">
| |
| − | <Echo>
| |
| − | <Details>
| |
| − | <Agencies ItemsCount="1">
| |
| − | <Agency Sequence="1">Operador Mariana Dos</Agency>
| |
| − | </Agencies>
| |
| − | </Details>
| |
| − | </Echo>
| |
| − | <Details>
| |
| − | <Agencies ItemsCount="1">
| |
| − | <Agency AgencyId="11539">
| |
| − | <Name>Operador Mariana Dos</Name>
| |
| − | <CreationUser>ADMINISTRADOR NEMO PRODUCCION</CreationUser>
| |
| − | <Identifiers ItemsCount="1">
| |
| − | <Identifier Sequence="1" Type="NMO.PRS.IDT.CUI">0413641121</Identifier>
| |
| − | </Identifiers>
| |
| − | <Emails ItemsCount="2">
| |
| − | <Email Sequence="1" Value="nemo" />
| |
| − | <Email Sequence="2" Value="cesar.palmieri@nemogroup.net" />
| |
| − | </Emails>
| |
| − | <Addresses ItemsCount="1">
| |
| − | <Address Sequence="1">sarmiento</Address>
| |
| − | </Addresses>
| |
| − | <TelephoneNumbers ItemsCount="1">
| |
| − | <Telephone Sequence="1" TelephoneType="Teléfono Principal">4475869</Telephone>
| |
| − | </TelephoneNumbers>
| |
| − | <Destinations Sequence="1" DestinationType="NMO.HTL.DST.CTY" DestinationCode="5735">Rosario</Destinations>
| |
| − | <PostalCode CountryCode="5735" />
| |
| − | </Agency>
| |
| − | </Agencies>
| |
| − | </Details>
| |
| − | </AgencyQueryRS>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | ! Parámetro !! Obligatorio !! Descripción
| |
| − | |-
| |
| − | | Details || SI || Detalle de la respuesta a la consulta de agencias.
| |
| − | |-
| |
| − | | Agencies || SI || Agencias de las que se obtiene información.
| |
| − | |-
| |
| − | | Name || SI || Nombre de la agencia.
| |
| − | |-
| |
| − | | CreationUser || SI || Usuario que la creó.
| |
| − | |-
| |
| − | | Emails || SI || Emails de la agencia.
| |
| − | |-
| |
| − | | Addresses || SI || Direcciones de la agencia.
| |
| − | |-
| |
| − | | TelephoneNumbers || SI || Números telefónicos de la agencia.
| |
| − | |-
| |
| − | | Destinations || SI || Ciudad de la agencia.
| |
| − | |-
| |
| − | | PostalCode || SI || Código postal de la agencia.
| |
| − | |}
| |
| − | | |
| − | = Pruebas de implementación =
| |
| − | | |
| − | Para realizar pruebas pueden usar un plugin de Chrome que permite hacer Request con archivos atachados. El plugin se puede descargar desde:
| |
| − | | |
| − | https://chrome.google.com/webstore/detail/advanced-rest-client/hgmloofddffdnphfgcellkdfbfbjeloo
| |
| − | | |
| − | Asimismo, pueden utilizar cualquier script que permita realizar un POST con headers y contenidos modificados.
| |
| − | | |
| − | Ejemplos de pasos para hacer una prueba:
| |
| − | | |
| − | | |
| − | '''* Como hacer una consulta de reservas:'''
| |
| − | | |
| − | * ''URL'': http://certnav.psurfer.net/backend.php/api/BookingsQueryRQ
| |
| − | | |
| − | * ''Method'': POST
| |
| − | | |
| − | * ''Headers'': Campo "Authorization" con user y password.
| |
| − | | |
| − | * ''Data (File)'':
| |
| − | | |
| − | File field name: BookingsQueryRQ
| |
| − | | |
| − | Archivo: (ver ejemplo de [[Price_Surfer_-_Export_contable#BookingsQueryRQ|BookingsQueryRQ]])
| |
| − | | |
| − | | |
| − | '''* Para los otros mensajes el procedimiento es el mismo, hay que adjuntar el archivo XML y setear el nombre (file field name) al mensaje que se esté llamando, estos son:'''
| |
| − | | |
| − | * Detalle de reserva:
| |
| − | http://certnav.psurfer.net/backend.php/api/BookingsDetailsRQ
| |
| − | | |
| − | * Aviso de pago de la reserva:
| |
| − | http://certnav.psurfer.net/backend.php/api/BookingPaymentStatusRQ
| |
| − | | |
| − | * Búsqueda de Agencia:
| |
| − | http://certnav.psurfer.net/backend.php/api/AgencyQueryRQ
| |
