Setup
Ez a cikk bemutatja, hogyan lehet gyorsan fejlesztőként beállítani és elkezdeni tesztelni API-jainkat a Winken.
:::megjegyzés A tesztelésnek mindig a miénkben kell történnieszínpadi környezetSokkal kevesebb adat van ott, de annyit tesztelhetsz, amennyit csak akarsz anélkül, hogy túlterhelnéd az éles környezetet.
Amint készen állsz az éles üzembe helyezésre, hitelesítjük a fiókodat és az alkalmazásodat, és elindíthatod az éles környezetünkben. :::
Kövesse az alábbi lépéseket:
- Nyilvántartás felhasználói fiókod a Wink-en
- Hozz létre egy utazási irodai számla vagy egy partnerfiók.
- Alkalmazás létrehozása ahol a 2. lépésben létrehozott fiókhoz társítja.
- Miután létrehoztad a
Application
, mentse el az ügyfél-azonosítót és az ügyfél titkos kódját biztonságos helyre.
A Winknél a Cloudinary-t használjuk minden kép- és videóanyagunkhoz. Amikor hozzáférsz az utazási készletünkhöz, teljes hozzáférést kapsz a Cloudinary összes fejlett funkciójához.
A miénkcloud_name
vantraveliko
.
Felhőszerű
Szekció neve “Felhőszerű”Példa
Szekció neve “Példa”Minden általunk támogatott utazási készlettípushoz tartozik egy beágyazott JSON tömb, amelynek nevemultimedias
Egy multimédiás bejegyzés JSON-ja így néz ki:
{ "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" } ]}
A fenti kiemelt sor a Cloudinary egyedi azonosítóját mutatja.partners/radisson_blu_logo
Ez minden, amire szükséged van a kép bármilyen formátumban, minőségben és méretben történő letöltéséhez.
Tesztelés
Szekció neve “Tesztelés”Menj át a miénkhezAPI-kszakaszt, és válassza ki a használni kívánt API-t.
API dokumentációk
Szekció neve “API dokumentációk”Dokumentációs oldalunk úgy van beállítva, hogy API parancsokat futtathasson az oldalon belül.
Ebben a példában a következőt szeretnéd használni:Search Lookups (OAuth2)
API-hívás.
:::tip[Profi tipp]
A könnyű használat érdekében azt javasoljuk, hogy az integrátorok az általunk kijelölt végpontokat használják.OAuth2
Ezek a végpontok tudják, hogy API-hívókra kell számítaniuk, és már tudják, melyik fiókkal vagy kapcsolatban, így nem kell megadnod acompanyIdentifier
az URL-címeidben.
:::
- Használd a Keresési API úti célok vagy szállodák lekéréséhez.
- A bal oldali navigációs sávon kattintson a
Authentication
. - Adja meg az ügyfél-azonosítóját és az ügyfél titkát, majd kattintson a
Get TOKEN
gomb. - Ha a hitelesítő adatai érvényesek, látni fogja, hogy az API-kulcsát alkalmazták.
- Most tesztelheti a keresési végpontot.
Postás
Szekció neve “Postás”Ugyanezt megteheted a Postman-nel is.
- Letöltés Postás.
- Kattintson ide
Download OpenAPI spec
a tetejéről Keresési API oldal. - Importáld a Postmanbe.
- Ha új gyűjteményként importáltad, amelynek neve
Wink API
, kattintson a gyűjtemény neve melletti vízszintes három pontra (3 pont), majd aEdit
. - A
Authorization tab
, állítsa be aAuth type
az OAuth2-höz. - Állítsa be a mezőt
Add auth data to
hogyRequest headers
. - Állítsa be a mezőt
Header prefix
hogyBearer
. - Állítsa be a mezőt
Token Name
arra a névre, amit a Postmanben el szeretnél nevezni a mentett tokenednek. Pl. Wink Staging. - Állítsa be a mezőt
Grant type
hogyClient Credentials
. - Állítsa be a mezőt
Access token URL
a https://staging-iam.wink.travel/oauth2/token címre. - Állítsa be a mezőt
Client ID
az alkalmazás által generált ügyfél-azonosítóhoz. - Állítsa be a mezőt
Client Secret
az alkalmazásod által generált ügyféltitokhoz. - Állítsa be a mezőt
Scope
hogyinventory.read inventory.write inventory.remove
Ezek az összes hatókörök, amire szükséged lesz a Winkhez. - Állítsa be a mezőt
Client Authentication
hogySend as Basic Auth header
. - Kattintson a
Get New Access Token
gombra a token lekéréséhez és mentéséhez. - A Wink API gyűjtemény alatti összes API-hívásnál győződjön meg arról, hogy a hitelesítési lapon ez áll:
Inherit auth from parent
így minden hívásba belefoglalja a tokenedet.
:::tip[Profi tipp] Ajánlott a kiszolgáló domainjét, az ügyfél-azonosítót és az ügyfél titkos kulcsát környezeti változókba tenni. Így könnyen válthat a tesztelési és az éles környezetek között, és újra felhasználhatja az összes létrehozott műveletet. :::