Setup
У цій статті показано, як швидко налаштуватися як розробник і почати тестувати наші API на Wink.
:::примітка Тестування завжди має відбуватися в нашомусередовище для проведення заходуТам набагато менше даних, але ви можете тестувати скільки завгодно, не нав’язуючи це виробничому середовищу.
Щойно ви будете готові до запуску, ми сертифікуємо ваш обліковий запис і вашу програму, і ви зможете запустити її в нашому робочому середовищі. :::
Виконайте такі дії:
- Зареєструватися ваш обліковий запис користувача на Wink
- Створити рахунок туристичного агента або партнерський обліковий запис.
- Створити програму де ви пов’язуєте його з обліковим записом, створеним на кроці 2.
- Після того, як ви створили свій
Application, збережіть ідентифікатор клієнта та секрет клієнта в безпечному місці.
У Wink ми використовуємо Cloudinary для всіх наших зображень та відео. Коли ви отримаєте доступ до нашого туристичного інвентарю, ви отримаєте повний доступ до всіх розширених функцій Cloudinary.
Нашcloud_nameєtraveliko.
Хмарний
Section titled “Хмарний”Приклад
Section titled “Приклад”Для кожного типу туристичного інвентарю, який ми підтримуємо, буде вкладений JSON-масив під назвоюmultimediasJSON для мультимедійного запису виглядає так:
{ "multimediaIdentifier": "multimedia-1", "identifier": "partners/radisson_blu_logo", "type": "IMAGE", "width": "1024", "height": "768", "category": "1", "descriptions": [ { "name": "Lobby", "description": "Picture of the lobby", "language": "en" } ], "lifestyleType": "LIFESTYLE_BUSINESS", "attribution": [ { "url": "https://www.hilton.com", "name": "Hilton" } ]}Виділений рядок вище показує унікальний ідентифікатор Cloudinarypartners/radisson_blu_logoЦе все, що вам потрібно, щоб отримати зображення в будь-якому форматі, якості та розмірі, які ви хочете.
Тестування
Section titled “Тестування”Завітайте до нашогоAPIрозділ і виберіть API, з яким ви хочете працювати.
Документація API
Section titled “Документація API”Наш сайт документації налаштовано таким чином, що ви можете запускати команди API прямо з сайту.
У цьому прикладі ви хочете використатиSearch Lookups (OAuth2)Виклик API.
:::tip[Порада професіонала]
Для зручності використання ми рекомендуємо інтеграторам використовувати кінцеві точки, які ми позначаємо якOAuth2Ці кінцеві точки знають, що потрібно викликати API, і вже знають, в якому обліковому записі ви перебуваєте, тому вам не потрібно вказувати його.companyIdentifierу ваших URL-адресах.
:::
- Використовуйте API пошуку щоб отримати напрямки або готелі.
- У лівій панелі навігації натисніть на
Authentication. - Введіть свій ідентифікатор клієнта та секретний код клієнта й натисніть
Get TOKENкнопка. - Якщо ваші облікові дані дійсні, ви побачите, що ваш ключ API застосовано.
- Тепер ви можете перевірити кінцеву точку пошуку.
Листоноша
Section titled “Листоноша”Ви можете зробити те саме з Листоношею.
- Завантажити Листоноша.
- Натисніть на
Download OpenAPI specз вершини API пошуку сторінка. - Імпортуйте його в Postman.
- Якщо ви імпортували його як нову колекцію під назвою
Wink API, натисніть на три крапки (три горизонтальні крапки) поруч із назвою колекції та натиснітьEdit. - У
Authorization tab, встановітьAuth typeдо OAuth2. - Встановити поле
Add auth data toдоRequest headers. - Встановити поле
Header prefixдоBearer. - Встановити поле
Token Nameяк забажаєте, щоб назвали свій збережений токен у Postman. Наприклад, Wink Staging. - Встановити поле
Grant typeдоClient Credentials. - Встановити поле
Access token URLдо https://staging-iam.wink.travel/oauth2/token. - Встановити поле
Client IDдо ідентифікатора клієнта, який допоміг згенерувати ваш додаток. - Встановити поле
Client Secretдо секретного номера клієнта, який допоміг згенерувати ваш додаток. - Встановити поле
Scopeдоinventory.read inventory.write inventory.removeЦе всі приціли, які вам знадобляться для Wink. - Встановити поле
Client AuthenticationдоSend as Basic Auth header. - Натисніть на
Get New Access Tokenкнопку, щоб отримати свій токен та зберегти його. - Для всіх викликів API в колекції Wink API переконайтеся, що на вкладці автентифікації зазначено
Inherit auth from parentтому він включає ваш токен до кожного виклику.
:::tip[Порада професіонала] Рекомендується перетворити домен сервера, ідентифікатор клієнта та секрет клієнта на змінні середовища. Таким чином, ви зможете легко перемикатися між проміжним та виробничим середовищами та повторно використовувати всі створені вами операції. :::