Изменения

← Предыдущая правка

Агентский API Отели

11 517 байт добавлено, 18:45, 6 мая 2019

Нет описания правки

{{Attention|В системе реализован усовершенствованный API-проект «Nemo Connect», настоятельно рекомендуем подключаться по схеме, описанной в документации по [http://docs.nemo.travel/ ссылке]}}

[[Категория:Агентский API]]

[[Категория:Интеграция]]

[[Файл:Nemo-logo.png‎|right]]

'''Агентский API ~~Отелей~~Отели''' - — система, которая предоставляет возможность поиска и бронирования отелей а так же получение информации о времени и размерах штрафов, уникальной информации об отеле, получение статической информации.

= Динамические данные =

'''WSDL''' (тестовый сервер): [http://tst.nemo-ibe.com/wsdev/wsdl.php?for=HotelsSearch http://tst.nemo-ibe.com/wsdev/wsdl.php?for=HotelsSearch]

==== Запрос ====

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

|-

| APIKey

| Обязательный. APIKey - секретный ключ доступа к API ~~ключ клиента~~Nemo.

Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".

| Латинские буквы и цифры. Всего 32 символа.

|}

</div>

==== Ответ ====

Система по заданным параметрам ищет отели и возвращает результаты поиска. Все результаты поиска хранятся в базе Nemo определенный срок и доступны для бронирования по идентификатору CacheId.

Атрибут Currency - код валюты.

|}

</div>

==== Ошибки ====

'''WSDL''' (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=HotelExtInfo

==== Запрос ====

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

|}

Элемент '''Source'''

{| style="width: 800px" class="wikitable"

|-

! scope="col" width="200" | Элемент

! scope="col" width="300" | Описание

! scope="col" width="300" | Допустимые значения

|-

| ClientID

| Обязательный. ID клиента в системе Nemo.

Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".

| Целое число.

|-

| APIKey

| Обязательный. APIKey - секретный ключ доступа к API Nemo.

Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".

| Латинские буквы и цифры. Всего 32 символа.

|}

</div>

==== Ответ ====

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

Атрибут Currency - код валюты.

|}

</div>

==== Ошибки ====

'''WSDL''' (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=Penalty

==== Запрос ====

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

|}

Элемент '''Source'''{| style="width: 800px" class="wikitable"|-! scope="col" width="200" | Элемент! scope="col" width="300" | Описание! scope="col" width="300" | Допустимые значения|-| ClientID| Обязательный. ID клиента в системе Nemo.Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".| Целое число.|-| APIKey| Обязательный. APIKey - секретный ключ доступа к API Nemo.Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".| Латинские буквы и цифры. Всего 32 символа.|}</div></div> <div class="toccolours mw-collapsible mw-collapsed" style="width:1000px">==== Ответ ====<div class="mw-collapsible-content"><syntaxhighlight lang="xml" line enclose="div" style="font-size:9pt;background: #F9F9F9; border: 1px dashed #2F6FAB; padding: 10px 5px; margin: 10px 0;"><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DPenalty"> <SOAP-ENV:Body> <ns1:penaltyResponse> <ResponseBin>

Атрибут: Currency - код валюты.

|}

</div>

==== Ошибки ====

== Бронирование ==

==== Запрос ====

Схема запроса позволяет указывать несколько услуг для бронирования сразу. Это было сделано с заделом на возможность расширения функциональности в будущем при сохранении совместимости.

|}

Элемент '''Source'''{| style="width: 800px" class="wikitable"|-! scope="col" width="200" | Элемент! scope="col" width="300" | Описание! scope="col" width="300" | Допустимые значения|-| ClientID| Обязательный. ID клиента в системе Nemo.Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".| Целое число.|-| APIKey| Обязательный. APIKey - секретный ключ доступа к API Nemo.Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".| Латинские буквы и цифры. Всего 32 символа.|}</div></div> <div class="toccolours mw-collapsible mw-collapsed" style="width:1000px">==== Ответ ====<div class="mw-collapsible-content">После выполнения запроса сразу поступит информация о бронировании. В первую очередь нужно внимательно проверить статусы <Status> всех услуг в бронировании. Если бронировалась услуга со статусом в результатах поиска RQ (по запросу), то статус скорее всего будет не равен «booked». Через некоторое время проверять реальный статус бука отправляя запрос на чтение данных о бронировании. <syntaxhighlight lang="xml" line enclose="div" style="font-size:9pt;background: #F9F9F9; border: 1px dashed #2F6FAB; padding: 10px 5px; margin: 10px 0;"><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DBooking" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<SOAP-ENV:Body>

<ns1:bookingResponse>

Информация о клиентах заказа полностью повторяет структуру запроса.

</div>

==== Ошибки ====

== Подтверждение бронирования ==

==== Запрос ====

Подтверждение бронирования заказа.

~~Для успешного запроса нужно указать:~~

~~#Номер заказа в системе.~~

~~#ID клиента.~~

~~#API ключ.~~

'''WSDL''' (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=ConfirmBooking

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ver="http://~~trunk~~tst.~~mlsd~~nemo-ibe.rucom/wsdev/?version%3D1.0%26for%3DConfirmBooking">

<soapenv:Header/>

<soapenv:Body>

</Request>

</syntaxhighlight>

Элемент '''Request'''{| style="width: 800px" class="wikitable"|-! scope="col" width="200" | Элемент! scope="col" width= ~~Выгрузка актуальных данных по заказу(ам)~~ "300" | Описание! scope="col" width="300" | Допустимые значения|-~~Используется для экспорта бронирований и для обновления данных~~ | BookingID| Обязательный. Идентификатор заказа в ~~локальной клиентской базе~~системе Nemo.| Целое число|}

Элемент '''~~WSDL~~Source''' ~~(тестовый сервер): http~~{| style="width:800px" class="wikitable"|-! scope="col" width="200" | Элемент! scope="col" width="300" | Описание! scope="col" width="300" | Допустимые значения|-| ClientID| Обязательный. ID клиента в системе Nemo.Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".| Целое число.|-| APIKey| Обязательный. APIKey - секретный ключ доступа к API Nemo.Можно посмотреть/~~tst~~добавить в "Администрирование" ⇨ "Веб-служба.~~nemo-ibe~~Авторизация".| Латинские буквы и цифры. Всего 32 символа.~~com~~|}</~~wsdev~~div></~~wsdl.php?for~~div> <div class="toccolours mw-collapsible mw-collapsed" style="width:1000px">==== Ответ ====<div class=~~Export~~"mw-collapsible-content">

~~==== Запрос ====~~

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DConfirmBooking"> <SOAP-ENV:Body> <ns1:confirmResponse> <ResponseBin> <Response> <Books> <Book> <Id>179547</Id> <Status>booked</Status> </Book> </Books> </Response> </ResponseBin> </ns1:confirmResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope></syntaxhighlight></div></div> ==== Ошибки ==== == Выгрузка актуальных данных по заказу(ам) ==Используется для экспорта бронирований и для обновления данных в локальной клиентской базе. '''WSDL''' (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=Export <div class="toccolours mw-collapsible mw-collapsed" style="width:1000px">==== Запрос ====<div class="mw-collapsible-content"><syntaxhighlight lang="xml" line enclose="div" style="font-size:9pt;background: #F9F9F9; border: 1px dashed #2F6FAB; padding: 10px 5px; margin: 10px 0;"><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ver="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DExport"> <soapenv:Header/> <soapenv:Body> <ver:export> <RequestBin>

</syntaxhighlight>

~~В запросе нужно указать~~ Элемент '''Item'''{| style="width: 800px" class="wikitable"|-! scope="col" width="200" | Элемент! scope="col" width="300" | Описание! scope="col" width="300" | Допустимые значения|-| Атрибут Id | Обязательный. Идентификатор заказа~~, который был получен~~ в ~~результате бронирования~~системе Nemo.| Целое число|}

Элемент '''Source'''{| style="width: 800px" class="wikitable"|-! scope="col" width="200" | Элемент! scope="col" width="300" | Описание! scope="col" width="300" | Допустимые значения|-| ClientID| Обязательный. ID клиента в системе Nemo.Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".| Целое число.|-| APIKey| Обязательный. APIKey - секретный ключ доступа к API Nemo.Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".| Латинские буквы и цифры. Всего 32 символа.|}</div></div> <div class="toccolours mw-collapsible mw-collapsed" style="width:1000px">==== Ответ ====<div class="mw-collapsible-content">

Ответ содержит элементы результатов бронирований. См. описание выше.

Формат ответа аналогичен результату бронирования.

</div>

==== Ошибки ====

== Аннуляция заказа ==

'''WSDL''' (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=CancelBooking

==== Запрос ====

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

|}

Элемент '''Source'''{| style="width: 800px" class="wikitable"|-! scope="col" width="200" | Элемент! scope="col" width="300" | Описание! scope="col" width="300" | Допустимые значения|-| ClientID| Обязательный. ID клиента в системе Nemo.Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".| Целое число.|-| APIKey| Обязательный. APIKey - секретный ключ доступа к API Nemo.Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".| Латинские буквы и цифры. Всего 32 символа.|}</div></div> ==== Ответ ====см. результаты бронирования.==== Ошибки ====* '''You can cancel only booked order''' - возникает при попытке аннулировать незабронированный заказ.* '''Invalid Booking Id N''' - заказ с номером N отсутствует. = Статические данные =

Для работы с веб-сервисом Nemo необходимо выгрузить статичные данные. Это данные о странах, городах и отелях.

== Страна ==

'''WSDL''' (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=CountryStatic

==== Запрос ====

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

|}

Элемент '''Source'''{| style="width: 800px" class="wikitable"|-! scope="col" width="200" | Элемент! scope="col" width="300" | Описание! scope="col" width="300" | Допустимые значения|-| ClientID| Обязательный. ID клиента в системе Nemo.Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".| Целое число.|-| APIKey| Обязательный. APIKey - секретный ключ доступа к API Nemo.Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".| Латинские буквы и цифры. Всего 32 символа.|}</div></div> <div class="toccolours mw-collapsible mw-collapsed" style="width:1000px">==== Ответ ====<div class="mw-collapsible-content"><syntaxhighlight lang="xml" line enclose="div" style="font-size:9pt;background: #F9F9F9; border: 1px dashed #2F6FAB; padding: 10px 5px; margin: 10px 0;"><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DCountryStatic" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <ns1:countriesResponse>

| Строка в произвольном формате.

|}

</div>

==== Ошибки ====

'''WSDL''' (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=CityStatic

==== Запрос ====

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

|}

Элемент '''Source'''

{| style="width: 800px" class="wikitable"

|-

! scope="col" width="200" | Элемент

! scope="col" width="300" | Описание

! scope="col" width="300" | Допустимые значения

|-

| ClientID

| Обязательный. ID клиента в системе Nemo.

Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".

| Целое число.

|-

| APIKey

| Обязательный. APIKey - секретный ключ доступа к API Nemo.

Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".

| Латинские буквы и цифры. Всего 32 символа.

|}

</div>

==== Ответ ====

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

| См. описание элемента Data в ответе получения информации о стране.

|}

</div>

==== Ошибки ====

'''WSDL''' (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=HotelStatic

==== Запрос ====

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

|}

Элемент '''Source'''

{| style="width: 800px" class="wikitable"

|-

! scope="col" width="200" | Элемент

! scope="col" width="300" | Описание

! scope="col" width="300" | Допустимые значения

|-

| ClientID

| Обязательный. ID клиента в системе Nemo.

Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".

| Целое число.

|-

| APIKey

| Обязательный. APIKey - секретный ключ доступа к API Nemo.

Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация".

| Латинские буквы и цифры. Всего 32 символа.

|}

</div>

==== Ответ ====

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

| Строка в произвольном формате.

|}

</div>

==== Ошибки ====

==См. также==

* [[Агентский интерфейс прикладного программирования (Агентский API)]]

* [[Схема использования агентского API (workflow)]]

* [[Агентский API Авиабилеты]]

* [[Агентский API Оплата]]

Александр Ермак

Бюрократы, Администраторы

224

правки