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_nameontraveliko.
Pilviympäristö
Osio nimeltä “Pilviympäristö”Esimerkki
Osio nimeltä “Esimerkki”Jokaiselle tukemallemme matkailuvarastotyypille on sisäkkäinen JSON-taulukko nimeltämultimediasMultimediamerkinnä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_logoSe on kaikki mitä tarvitset kuvan hakemiseen missä tahansa muodossa, laadussa ja koossa.
Testaus
Osio nimeltä “Testaus”Suuntaa meidänAPI-rajapinnatosiossa ja valitse API, jonka kanssa haluat työskennellä.
API-dokumentaatio
Osio nimeltä “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äneetOAuth2Nuo päätepisteet osaavat odottaa API-kutsujia ja tietävät jo, millä tilillä olet, joten sinun ei tarvitse määrittääcompanyIdentifierURL-osoitteissasi.
:::
- Käytä Haku-API hakeaksesi kohteita tai hotelleja.
- Napsauta vasemmassa navigointipalkissa
Authentication. - Syötä asiakastunnuksesi ja asiakkaan salaisuus ja napsauta
Get TOKENpainiketta. - Jos tunnistetietosi ovat kelvolliset, näet, että API-avaimesi on otettu käyttöön.
- Voit nyt testata hakupäätepistettä.
Postinkantaja
Osio nimeltä “Postinkantaja”Voit tehdä saman asian Postmanin kanssa.
- Lataa Postinkantaja.
- Klikkaa
Download OpenAPI specylhää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 typeOAuth2:een. - Aseta kenttä
Add auth data toettäRequest headers. - Aseta kenttä
Header prefixettäBearer. - Aseta kenttä
Token Namemihin tahansa haluat nimetä tallennetun tokenisi Postmanissa. Esim. Wink Staging. - Aseta kenttä
Grant typeettäClient Credentials. - Aseta kenttä
Access token URLosoitteeseen https://staging-iam.wink.travel/oauth2/token. - Aseta kenttä
Client IDasiakastunnukseen, jonka luomisessa sovelluksesi oli mukana. - Aseta kenttä
Client Secretasiakassalaisuuteen, jonka luomisessa sovelluksesi oli mukana. - Aseta kenttä
Scopeettäinventory.read inventory.write inventory.removeNuo ovat kaikki Winkille tarvittavat laajuusalueet. - Aseta kenttä
Client Authenticationettä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 parentjoten 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. :::