Setup
W tym artykule dowiesz się, jak szybko zostać programistą i rozpocząć testowanie naszych interfejsów API w systemie Wink.
Testowanie powinno zawsze odbywać się w naszymśrodowisko testowe. Jest tam o wiele mniej danych, ale możesz testować tyle, ile chcesz, bez obciążania środowiska produkcyjnego.
Gdy będziesz gotowy do uruchomienia, certyfikujemy Twoje konto i aplikację, a Ty będziesz mógł uruchomić je w naszym środowisku produkcyjnym.
Wykonaj następujące kroki:
- Rejestr Twoje konto użytkownika w Wink
- Utwórz konto agenta podróży lub konto partnerskie.
- Utwórz aplikację gdzie powiążesz je z kontem utworzonym w kroku 2.
- Po utworzeniu
Application
, zapisz identyfikator klienta i tajny klucz klienta w bezpiecznym miejscu.
W Wink używamy Cloudinary do wszystkich naszych zasobów graficznych i wideo. Kiedy uzyskasz dostęp do naszego inwentarza podróży, będziesz mieć pełny dostęp do wszystkich zaawansowanych funkcji Cloudinary.
Nasz cloud_name
Jest traveliko
.
Zachmurzony
Dział zatytułowany „Zachmurzony”Przykład
Dział zatytułowany „Przykład”Dla każdego obsługiwanego przez nas typu inwentarza podróży będzie istniała zagnieżdżona tablica JSON o nazwiemultimedias
. Kod JSON dla wpisu multimedialnego wygląda następująco:
{ "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" } ]}
Podświetlony wiersz powyżej pokazuje unikalny identyfikator Cloudinarypartners/radisson_blu_logo
. To wszystko, czego potrzebujesz, aby pobrać obraz w dowolnym formacie, jakości i rozmiarze.
Testowanie
Dział zatytułowany „Testowanie”Przejdź do naszejPszczołai wybierz API, z którym chcesz pracować.
Dokumentacja API
Dział zatytułowany „Dokumentacja API”Nasza witryna z dokumentacją jest skonfigurowana w taki sposób, aby można było uruchamiać polecenia API z poziomu witryny.
W tym przykładzie chcesz użyćSearch Lookups (OAuth2)
Wywołanie API.
:::tip[Pro Tip]
Dla łatwości użytkowania zalecamy, aby integratorzy używali punktów końcowych, które określamy jakoOAuth2
Te punkty końcowe wiedzą, że mają oczekiwać wywołań API i już wiedzą, na którym koncie się znajdujesz, więc nie musisz określaćcompanyIdentifier
w Twoich adresach URL.
:::
- Użyj API wyszukiwania aby pobrać miejsca docelowe lub hotele.
- Na pasku nawigacyjnym po lewej stronie kliknij
Authentication
. - Wprowadź swój identyfikator klienta i tajny klucz klienta, a następnie kliknij
Get TOKEN
przycisk. - Jeśli Twoje dane uwierzytelniające są prawidłowe, zobaczysz, że klucz API został zastosowany.
- Teraz możesz przetestować punkt końcowy wyszukiwania.
Listonosz
Dział zatytułowany „Listonosz”To samo możesz zrobić za pomocą Postmana.
- Pobierać Listonosz.
- Kliknij na
Download OpenAPI spec
ze szczytu API wyszukiwania strona. - Zaimportuj do Postmana.
- Jeśli zaimportowałeś go jako nową kolekcję o nazwie
Wink API
, kliknij na poziomy elips (3 kropki) obok nazwy kolekcji i kliknijEdit
. - W
Authorization tab
, ustawAuth type
do OAuth2. - Ustaw pole
Add auth data to
DoRequest headers
. - Ustaw pole
Header prefix
DoBearer
. - Ustaw pole
Token Name
na dowolną nazwę, jaką chcesz nadać swojemu zapisanemu tokenowi w Postmanie. Np. Wink Staging. - Ustaw pole
Grant type
DoClient Credentials
. - Ustaw pole
Access token URL
do https://staging-iam.wink.travel/oauth2/token. - Ustaw pole
Client ID
do identyfikatora klienta, który Twoja aplikacja pomogła wygenerować. - Ustaw pole
Client Secret
do Tajemnicy Klienta, którą pomogła wygenerować Twoja aplikacja. - Ustaw pole
Scope
Doinventory.read inventory.write inventory.remove
. To wszystkie zakresy, których będziesz potrzebować do Wink. - Ustaw pole
Client Authentication
DoSend as Basic Auth header
. - Kliknij
Get New Access Token
aby odzyskać swój token i go zapisać. - W przypadku wszystkich wywołań API w ramach kolekcji API Wink upewnij się, że na karcie uwierzytelniania jest wyświetlona informacja
Inherit auth from parent
więc przy każdym wywołaniu uwzględnia Twój token.
:::tip[Pro Tip] Zaleca się, aby domena serwera, identyfikator klienta i sekret klienta stały się zmiennymi środowiskowymi. W ten sposób można łatwo przełączać się między środowiskami testowymi i produkcyjnymi oraz ponownie wykorzystywać wszystkie utworzone operacje. :::