Setup
Tässä artikkelissa näytetään, kuinka pääset nopeasti kehittäjäksi ja aloitat API-rajapintojemme testaamisen Winkissä.
Testauksen tulisi aina tapahtua meidänlavastusympäristöSiellä on paljon vähemmän dataa, mutta voit testata niin paljon kuin haluat rajoittamatta tuotantoympäristöä.
Kun olet valmis julkaisemaan sovelluksesi, sertifioimme tilisi ja sovelluksesi, ja voit julkaista sen tuotantoympäristössämme.
Noudata näitä ohjeita:
- Rekisteröidy käyttäjätilisi Winkissä
- Luo matkatoimiston tili tai kumppanitili.
- Luo sovellus jossa liität sen vaiheessa 2 luomaasi tiliin.
- Kun olet luonut oman
Application
, tallenna asiakastunnus ja asiakkaan salaisuus turvalliseen paikkaan.
Winkillä käytämme Cloudinarya kaikissa kuva- ja videoresursseissamme. Kun käytät matkakuvastoamme, saat täyden käyttöoikeuden kaikkiin Cloudinaryn edistyneisiin ominaisuuksiin.
Meidäncloud_name
ontraveliko
.
Pilviympäristö
Section titled “Pilviympäristö”Esimerkki
Section titled “Esimerkki”Jokaiselle tukemallemme matkailuvarastotyypille on sisäkkäinen JSON-taulukko nimeltämultimedias
Multimediamerkinnän JSON-tiedosto näyttää tältä:
{ "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" } ]}
Yllä oleva korostettu rivi näyttää Cloudinaryn yksilöllisen tunnuksenpartners/radisson_blu_logo
Se on kaikki mitä tarvitset kuvan hakemiseen missä tahansa muodossa, laadussa ja koossa.
Testaus
Section titled “Testaus”Suuntaa meidänAPI-rajapinnatosiossa ja valitse API, jonka kanssa haluat työskennellä.
API-dokumentaatio
Section titled “API-dokumentaatio”Dokumentaatiosivustomme on rakennettu siten, että voit suorittaa API-komentoja sivuston sisältä.
Tässä esimerkissä haluat käyttääSearch Lookups (OAuth2)
API-kutsu.
:::tip[Pro-vinkki]
Käytön helpottamiseksi suosittelemme, että integraattorit käyttävät päätepisteitä, jotka olemme määrittäneetOAuth2
Nuo päätepisteet osaavat odottaa API-kutsujia ja tietävät jo, millä tilillä olet, joten sinun ei tarvitse määrittääcompanyIdentifier
URL-osoitteissasi.
:::
- Käytä Haku-API hakeaksesi kohteita tai hotelleja.
- Napsauta vasemmassa navigointipalkissa
Authentication
. - Syötä asiakastunnuksesi ja asiakkaan salaisuus ja napsauta
Get TOKEN
painiketta. - Jos tunnistetietosi ovat kelvolliset, näet, että API-avaimesi on otettu käyttöön.
- Voit nyt testata hakupäätepistettä.
Postinkantaja
Section titled “Postinkantaja”Voit tehdä saman asian Postmanin kanssa.
- Lataa Postinkantaja.
- Klikkaa
Download OpenAPI spec
ylhäältä Haku-API sivu. - Tuo se Postmaniin.
- Jos tuot sen uutena kokoelmana nimeltä
Wink API
, napsauta kokoelman nimen vieressä olevaa vaakasuoraa kolmea pistettä (kolme pistettä) ja napsautaEdit
. - Sisään
Authorization tab
, asetaAuth type
OAuth2:een. - Aseta kenttä
Add auth data to
ettäRequest headers
. - Aseta kenttä
Header prefix
ettäBearer
. - Aseta kenttä
Token Name
mihin tahansa haluat nimetä tallennetun tokenisi Postmanissa. Esim. Wink Staging. - Aseta kenttä
Grant type
ettäClient Credentials
. - Aseta kenttä
Access token URL
osoitteeseen https://staging-iam.wink.travel/oauth2/token. - Aseta kenttä
Client ID
asiakastunnukseen, jonka luomisessa sovelluksesi oli mukana. - Aseta kenttä
Client Secret
asiakassalaisuuteen, jonka luomisessa sovelluksesi oli mukana. - Aseta kenttä
Scope
ettäinventory.read inventory.write inventory.remove
Nuo ovat kaikki Winkille tarvittavat laajuusalueet. - Aseta kenttä
Client Authentication
ettäSend as Basic Auth header
. - Klikkaa
Get New Access Token
-painiketta noutaaksesi tunnuksesi ja tallentaaksesi sen. - Varmista, että kaikkien Wink API -kokoelman API-kutsujen kohdalla todennusvälilehdellä lukee
Inherit auth from parent
joten se sisällyttää tokenisi jokaisen kutsun mukana.
:::tip[Ammattilaisvinkki] On suositeltavaa tehdä palvelimen toimialue, asiakastunnus ja asiakkaan salaisuus ympäristömuuttujiksi. Tällä tavoin voit helposti vaihtaa testiympäristön ja tuotantoympäristön välillä ja käyttää uudelleen kaikkia luomiasi toimintoja. :::