API MAG.Travel

Авторизация

В Mag.travel реализована авторизация по протоколу OAuth

Протокол OAuth обеспечивает авторизацию третье стороне, позволяя таким образом работать с API Mag.travel.
Иногда полноценная авторизация агентства программным способом не удобна или невозможна в принципе. Это может быть использовано при внешнем взаимодействии.

Для получения доступа к API необходимо получить имя пользователя для доступа к API и его clientSecret

Получение токена

Пример запроса для получения токена OAuth:

Получения токенаOAuth.
Запрос:	POST https://2015.mag.travel/tourclient/token
Headers:	Content-Type: application/x-www-form-urlencoded Referer: localhost
Body:	grant_type : mag_oauth_grant name — Уникальное имя пользователя OAuth clientSecret – Полученный при регистрации secretKey
Результат:	Объект json с полями: access_token —String, токен. token_type — String, Тип токена. Обычно это "bearer", expires_in — Int,время жизни токена

Отправка запроса к API Mag.Travel.

Пример запроса к API с полученным токеном OAuth:

Запрос к API с полученным токеном.
Headers:	Authorization: "Bearer %TOKEN%" - где %TOKEN% - это ранее полученный токен

Проверка токена

Иногда бывает полезно удостовериться заранее, что токен актуален и его срок действия не истек :

Получение токена OAuth.
Запрос:	GET https://2015.mag.travel/tourclient/api/OAuth/CheckToken
Headers:	Authorization: "Bearer %TOKEN%" - где %TOKEN% - это ранее полученный токен
Результат:	Объект json с полями: Result – bool, действителен ли токен

CurrencyRatesApi

API	Description
GET api/CurrencyRates?from={from}&to={to}&currencyId={currencyId}	-
GET api/CurrencyRates/operator?from={from}&to={to}&currencyId={currencyId}&partnerId={partnerId}&gateCode={gateCode}	-

Туры. Управление турами

API	Description
GET api/tour/management	-
GET api/tour/management/Statistic	-
GET api/tour/management/BoardItem	-
GET api/tour/management/Board	-
GET api/tour/management/{id}	-
POST api/tour/management	-
DELETE api/tour/management/{id}	-

Туры. Фильтры туров (заведенных в Маге)

API	Description
GET api/tour/filter/TourName	-
GET api/tour/filter/departure	-
GET api/tour/filter/country	-
GET api/tour/filter/TourType	-
GET api/tour/filter/city?CountryId={CountryId}&DepartureCityId={DepartureCityId}	-
GET api/tour/filter/OwnerLegal?PartnerId={PartnerId}	-
GET api/tour/filter/transport?TransportId={TransportId}	-
GET api/tour/filter/TourDates?CountryId={CountryId}&DepartureCityId={DepartureCityId}	-

AlfaBank

API	Description
GET OnlinePayment/ab/{partnerId}/{paySettingId}?mdOrder={mdOrder}&orderNumber={orderNumber}&checksum={checksum}&operation={operation}&paymentState={paymentState}&status={status}&amount={amount}&approvedAmount={approvedAmount}&paymentDate={paymentDate}&paymentWay={paymentWay}	-
POST OnlinePayment/ab/{partnerId}/{paySettingId}?mdOrder={mdOrder}&orderNumber={orderNumber}&checksum={checksum}&operation={operation}&paymentState={paymentState}&status={status}&amount={amount}&approvedAmount={approvedAmount}&paymentDate={paymentDate}&paymentWay={paymentWay}	-

ClientApi

API	Description
GET api/clientapi/clientcorrespondence?clientId={clientId}&groupType={groupType}	-
POST api/clientapi/attachments?clientId={clientId}	-
POST api/clientapi/file	-
POST api/clientapi/attachfile?clientId={clientId}	-
POST api/clientapi/updatefile?fileId={fileId}&useInAgreements={useInAgreements}
POST api/clientapi/removefile?id={id}	Удаление файла по его номеру
POST api/clientapi/map	-
POST api/clientapi/replace	-
GET api/clientapi/history?clientId={clientId}	-
GET api/clientapi/fastSearch	-
GET api/ClientApi/Get?id={id}	-
GET api/ClientApi/Get	-
PUT api/ClientApi/Put	-
DELETE api/ClientApi/Delete	-
GET api/ClientApi/{id}	-
GET api/ClientApi	-
PUT api/ClientApi	-
DELETE api/ClientApi	-
GET api/ClientApi/Get/{id}	-
GET api/ClientApi/Get/{name}?id={id}	-
GET api/ClientApi/Get/{name}	-
PUT api/ClientApi/Put/{name}	-
DELETE api/ClientApi/Delete/{name}	-

Agreement

API	Description
PATCH api/agreement/{code}	Обновление отдельных полей путевки
PUT api/Agreement/Put	-
PUT api/Agreement	-
PUT api/Agreement/Put/{name}	-

PartnerApi

API	Description
GET api/partner/list	-
POST api/partner/list	-
GET api/partner/{id}	-
POST api/partner/Registration	-
GET api/partner/accounts	-
GET api/partner/accountData/{supplierCode}	-
POST api/partner/accountData	-
DELETE api/partner/removeAccountData/{supplierCode}	-
POST api/partner/attachFile/{partnerId}	-
POST api/partner/attachSubAgentAgreement/{partnerId}	-
POST api/PartnerApi/UpdatePartner	-
POST api/PartnerApi	-
POST api/PartnerApi/UpdatePartner/{name}	-

Туры. Поиск туров (заведенных в Маге)

API	Description
GET api/tour/search/Tours	-
GET api/tour/search/TourInfo?tourId={tourId}	-
GET api/tour/search/GetAccessibleTourInfo?tourId={tourId}	-
GET api/tour/search/DatePrices	-

Lead

API	Description
GET api/lead/all	-
GET api/lead/template	Получение шаблонной информации о лиде (доп. описания, например)
POST api/lead/updatestatus	обновление статуса у лида
PUT api/lead/offer/{id}	-
PUT api/lead/offers/{id}	Добавление предложений в лид
GET api/lead/offers?LeadId={LeadId}&ClientId={ClientId}	Получение предложений по фильтру
GET api/lead/appeal/{id}	-
PUT api/lead/appeals/{id}	-
GET api/lead/appeals?appealClientId={appealClientId}	-
PUT api/lead/appeal/{id}	-
POST api/lead/clonedata	-
POST api/lead/attachments?id={id}	-
GET api/lead/attachments?id={id}	-
GET api/lead/file?sepString={sepString}	-
POST api/lead/attachfile?leadId={leadId}	-
POST api/lead/updatefile?fileId={fileId}&useInAgreements={useInAgreements}
POST api/lead/removefile?id={id}	Удаление файла по его номеру
GET api/lead/emailtemplate?id={id}	-
GET api/lead/ProposalEmailTemplate?id={id}&offerId={offerId}	-
POST api/lead/setarchiveflag	-
GET api/Lead/Get?id={id}&isEventRequest={isEventRequest}	Получение лида по ID
GET api/Lead/Get	Получение списка лидов по фильтру или без него
PUT api/Lead/Put	Создание/изменение лида
DELETE api/Lead/Delete?id={id}	Удаление лида по ID
GET api/Lead/{id}?isEventRequest={isEventRequest}	Получение лида по ID
GET api/Lead	Получение списка лидов по фильтру или без него
PUT api/Lead	Создание/изменение лида
DELETE api/Lead/{id}	Удаление лида по ID
GET api/Lead/Get/{id}?isEventRequest={isEventRequest}	Получение лида по ID
DELETE api/Lead/Delete/{id}	Удаление лида по ID
GET api/Lead/Get/{name}?id={id}&isEventRequest={isEventRequest}	Получение лида по ID
GET api/Lead/Get/{name}	Получение списка лидов по фильтру или без него
PUT api/Lead/Put/{name}	Создание/изменение лида
DELETE api/Lead/Delete/{name}?id={id}	Удаление лида по ID

PayOnline

API	Description
POST OnlinePayment/PayOnline/approved/{partnerId}/{paySettingId}	DateTime=2024-02-29+13%3a30%3a26&TransactionID=242456714&OrderId=02291327&Amount=5.00&Currency=RUB&SecurityKey=4f76db31481b6feeafc3b57ae15afd7d&Provider=Card&PaymentAmount=5.00&PaymentCurrency=RUB&CardHolder=Oleg+tarasov&CardNumber=******2277&ECI=7&Code=1999&ErrorCode=2 DateTime=2024-02-28+09%3a23%3a27&TransactionID=341660076&OrderId=25382344&Amount=2.00&Currency=RUB&QrCodeId=1058919&SecurityKey=3233e92bd0227758b93cb5fdea160621&lang=ru&Provider=Qr&RebillAnchor=XXX
POST OnlinePayment/PayOnline/declined/{partnerId}/{paySettingId}	-

API

Description

POST OnlinePayment/PayOnline/approved/{partnerId}/{paySettingId}

DateTime=2024-02-29+13%3a30%3a26&TransactionID=242456714&OrderId=02291327&Amount=5.00&Currency=RUB&SecurityKey=4f76db31481b6feeafc3b57ae15afd7d&Provider=Card&PaymentAmount=5.00&PaymentCurrency=RUB&CardHolder=Oleg+tarasov&CardNumber=******2277&ECI=7&Code=1999&ErrorCode=2 DateTime=2024-02-28+09%3a23%3a27&TransactionID=341660076&OrderId=25382344&Amount=2.00&Currency=RUB&QrCodeId=1058919&SecurityKey=3233e92bd0227758b93cb5fdea160621&lang=ru&Provider=Qr&RebillAnchor=XXX

POST OnlinePayment/PayOnline/declined/{partnerId}/{paySettingId}

Платежи

API	Description
POST api/payment/list	Список платежей
GET api/payment/{id}	Загрузка информации о платеже по id
POST api/payment/details	Список детализаций платежей Отличается от платежа тем, что платеж может быть по нескольким путевкам и по такому платежу будет несколько детализаций
POST api/payment	Добавление/редактирование платежа При добавлении ID не передается
DELETE api/payment/{id}	Удаление платежа по id

History

API	Description
GET api/history/{type}/{id}	Получение истории по типу и ID записи

API	Description
GET api/tag/{entityTypeId}	-
POST api/tag	-
POST api/tag/remove	-

SearchEntities

API	Description
GET api/SearchEntities	-
POST api/SearchEntities	-

AdditionalValuesApi

работа с доп описаниями

API	Description
GET api/additionalvalues/{tableId}/{rowId}	-
GET api/additionalvalues/{tableId}	-
PUT api/AdditionalValuesApi/Update?request={request}	Обновление доп описаний
POST api/AdditionalValuesApi/Update	-
PUT api/AdditionalValuesApi?request={request}	Обновление доп описаний
POST api/AdditionalValuesApi	-
PUT api/AdditionalValuesApi/Update/{name}?request={request}	Обновление доп описаний
POST api/AdditionalValuesApi/Update/{name}	-

Сертификаты/Дотации

API	Description
POST api/GiftCertificate/all	-
GET api/GiftCertificate?id={id}&number={number}&getSubsidies={getSubsidies}	-
POST api/GiftCertificate	-
POST api/GiftCertificate/delete	-
GET api/GiftCertificate/managers	-
GET api/GiftCertificate/users	Метод получения списка сотрудников, которым ваданы сертификаты
GET api/GiftCertificate/points?userId={userId}	Метод получения доступных пользователю баллов
GET api/GiftCertificate/publicoffers	Метод получения ссылок на оплату дотациями через договор-оферты

Country

API	Description
GET api/Country/{partnerId}	-
GET api/Country/All?request={request}	Загрузка списка стран
GET api/Country?request={request}	Загрузка списка стран
GET api/Country/All/{name}?request={request}	Загрузка списка стран

Туры. Бронирование туров (заведенных в Маге) из виджета

API	Description
POST api/tour/basket/calculate	-
POST api/tour/basket/book	-

FavouriteSelectionApi

API	Description
GET api/FavouriteSelectionApi/Get	-
POST api/FavouriteSelectionApi/Post	-
DELETE api/FavouriteSelectionApi/Delete?id={id}	-
GET api/FavouriteSelectionApi	-
POST api/FavouriteSelectionApi	-
DELETE api/FavouriteSelectionApi/{id}	-
DELETE api/FavouriteSelectionApi/Delete/{id}	-
GET api/FavouriteSelectionApi/Get/{name}	-
POST api/FavouriteSelectionApi/Post/{name}	-
DELETE api/FavouriteSelectionApi/Delete/{name}?id={id}	-

API	Description
GET api/Advertisement/All?request={request}	Получение списка источников рекламы
GET api/Advertisement?request={request}	Получение списка источников рекламы
GET api/Advertisement/All/{name}?request={request}	Получение списка источников рекламы

OrderApi

API	Description
GET api/OrderApi/GetOne	-
GET api/OrderApi/GetFullAgreementData?AgreementCode={AgreementCode}	-
POST api/OrderApi/PaymentSystemUrls?AgreementCode={AgreementCode}	Получение списка страниц оплаты для доступных платежных систем
GET api/OrderApi/GetAgreementFile?OrderCode={OrderCode}&FileId={FileId}&SepString={SepString}&NeedLog={NeedLog}	-
POST api/OrderApi/PayKeeperSystemUrl	-
POST api/OrderApi/PayTravelSystemUrl	-
GET api/OrderApi	-
GET api/OrderApi?AgreementCode={AgreementCode}	-
POST api/OrderApi?AgreementCode={AgreementCode}	Получение списка страниц оплаты для доступных платежных систем
GET api/OrderApi?OrderCode={OrderCode}&FileId={FileId}&SepString={SepString}&NeedLog={NeedLog}	-
GET api/OrderApi/GetOne/{name}	-
GET api/OrderApi/GetFullAgreementData/{name}?AgreementCode={AgreementCode}	-
POST api/OrderApi/PaymentSystemUrls/{name}?AgreementCode={AgreementCode}	Получение списка страниц оплаты для доступных платежных систем
GET api/OrderApi/GetAgreementFile/{name}?OrderCode={OrderCode}&FileId={FileId}&SepString={SepString}&NeedLog={NeedLog}	-
POST api/OrderApi/PayKeeperSystemUrl/{name}	-
POST api/OrderApi/PayTravelSystemUrl/{name}	-

NotesApi

Api контроллер для работы с примечаниями

API	Description
POST api/NotesApi/Update	Метод добавления/обновления примечания
POST api/NotesApi/Delete	Метод удаления примечания
POST api/NotesApi/Update/{name}	Метод добавления/обновления примечания
POST api/NotesApi/Delete/{name}	Метод удаления примечания

City

API	Description
GET api/City/All?countryId={countryId}	Загрузка списка городов
GET api/City?countryId={countryId}	Загрузка списка городов
GET api/City/All/{name}?countryId={countryId}	Загрузка списка городов