Setup
Þessi grein sýnir þér hvernig á að koma sér fljótt fyrir sem forritari og byrja að prófa API-viðmótin okkar á Wink.
:::athugið Prófanir ættu alltaf að fara fram í okkarsviðsetningarumhverfiÞað eru miklu minni gögn þar en þú ert frjáls til að prófa eins mikið og þú vilt án þess að það skipti miklu máli fyrir framleiðsluumhverfið.
Þegar þú ert tilbúinn/tilbúin til að fara í loftið, munum við votta aðganginn þinn og forritið og þú getur ræst það í framleiðsluumhverfi okkar. :::
Fylgdu þessum skrefum:
- Skráning notandareikningurinn þinn á Wink
- Búa til reikningur ferðaskrifstofu eða tengdareikningur.
- Búa til umsókn þar sem þú tengir það við reikninginn sem þú bjóst til í skrefi 2.
- Þegar þú hefur búið til þitt
Application
, vistaðu viðskiptavinaauðkennið og leyndarmál viðskiptavinar á öruggum stað.
Hjá Wink notum við Cloudinary fyrir allar myndir og myndbönd okkar. Þegar þú opnar ferðasafnið okkar færðu aðgang að öllum háþróuðum eiginleikum Cloudinary.
Okkarcloud_name
ertraveliko
.
Skýjað
Section titled “Skýjað”Fyrir hverja ferðaskráartegund sem við styðjum verður innfelld JSON-fylki sem kallastmultimedias
JSON skráin fyrir margmiðlunarfærslu lítur svona út:
{ "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" } ]}
Merkta línan hér að ofan sýnir einstaka auðkenni Cloudinarypartners/radisson_blu_logo
Það er allt sem þú þarft til að sækja myndina í hvaða sniði, gæðum og stærð sem þú vilt.
Prófanir
Section titled “Prófanir”Farðu yfir til okkarAPI-viðmótkaflanum og veldu API-ið sem þú vilt vinna með.
API skjöl
Section titled “API skjöl”Skjalasíða okkar er sett upp þannig að þú getur keyrt API skipanir innan síðunnar.
Í þessu dæmi viltu notaSearch Lookups (OAuth2)
API-kall.
:::ráð[Fagráð]
Til að auðvelda notkun mælum við með að samþættingaraðilar noti endapunktana sem við tilnefnum semOAuth2
Þessir endapunktar vita að búast má við API-köllum og vita nú þegar hvaða reikning þú ert á svo þú þarft ekki að tilgreina það.companyIdentifier
í vefslóðunum þínum.
:::
- Notaðu Leitarforritaskil til að sækja áfangastaði eða hótel.
- Í vinstri yfirlitsstikunni smellirðu á
Authentication
. - Sláðu inn viðskiptavinaauðkenni þitt og leyndarmál viðskiptavinar og smelltu á
Get TOKEN
hnappur. - Ef innskráningarupplýsingar þínar eru gildar, munt þú sjá að API lykillinn þinn hefur verið notaður.
- Nú er hægt að prófa uppflettingarendapunktinn.
Póstberi
Section titled “Póstberi”Þú getur gert það sama með Póstmanninn.
- Sækja Póstberi.
- Smelltu á
Download OpenAPI spec
frá toppnum á Leitarforritaskil síðu. - Flytja það inn í Postman.
- Ef þú fluttir það inn sem nýtt safn sem kallast
Wink API
, smelltu á lárétta þrípunktinn (3 punktar) við hliðina á nafni safnsins og smelltu áEdit
. - Í
Authorization tab
, stilltuAuth type
til OAuth2. - Setja reitinn
Add auth data to
tilRequest headers
. - Setja reitinn
Header prefix
tilBearer
. - Setja reitinn
Token Name
hverju nafni sem þú vilt gefa vistaða táknið þitt í Postman. T.d. Wink Staging. - Setja reitinn
Grant type
tilClient Credentials
. - Setja reitinn
Access token URL
á https://staging-iam.wink.travel/oauth2/token. - Setja reitinn
Client ID
við viðskiptavinaauðkennið sem appið þitt hjálpaði til við að búa til. - Setja reitinn
Client Secret
við leyndarmál viðskiptavinarins sem appið þitt hjálpaði til við að mynda. - Setja reitinn
Scope
tilinventory.read inventory.write inventory.remove
Þetta eru öll þau sjónsvið sem þú þarft fyrir Wink. - Setja reitinn
Client Authentication
tilSend as Basic Auth header
. - Smelltu á
Get New Access Token
hnappinn til að sækja táknið þitt og vista það. - Fyrir öll API-köll innan Wink API-safnsins, vertu viss um að auðkenningarflipinn segi
Inherit auth from parent
svo það fylgir táknið þitt með í hverju símtali.
:::ráð[Fagráð] Mælt er með að breyta léni netþjónsins, viðskiptavinaauðkenni og leyndarmáli viðskiptavinar í umhverfisbreytur. Þannig er auðvelt að skipta á milli sviðsetningar- og framleiðsluumhverfis og endurnýta allar aðgerðir sem þú hefur búið til. :::