Setup
Šiame straipsnyje parodyta, kaip greitai tapti kūrėju ir pradėti testuoti mūsų API „Wink“.
Testavimas visada turėtų būti atliekamas mūsųscenos aplinkaTen yra daug mažiau duomenų, bet galite testuoti tiek, kiek norite, neapkraudami gamybinės aplinkos.
Kai būsite pasiruošę paleisti programą, mes sertifikuosime jūsų paskyrą ir paraišką, ir galėsite ją paleisti mūsų gamybinėje aplinkoje.
Atlikite šiuos veiksmus:
- Registruotis jūsų vartotojo paskyra „Wink“
- Sukurti kelionių agento sąskaita arba partnerio paskyra.
- Sukurti paraišką kur susiejate jį su paskyra, kurią sukūrėte atlikdami 2 veiksmą.
- Kai sukursite savo
Application
, išsaugokite kliento ID ir kliento slaptąjį raktą saugioje vietoje.
„Wink“ naudojame „Cloudinary“ visiems savo vaizdams ir vaizdo įrašams. Prisijungę prie mūsų kelionių inventoriaus, turėsite visišką prieigą prie visų išplėstinių „Cloudinary“ funkcijų.
Mūsųcloud_name
yratraveliko
.
Debesuota
Section titled “Debesuota”Pavyzdys
Section titled “Pavyzdys”Kiekvienam mūsų palaikomam kelionių inventoriaus tipui bus įdėtas JSON masyvas, vadinamasmultimedias
Multimedijos įrašo JSON formatas atrodo taip:
{ "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" } ]}
Paryškinta eilutė aukščiau rodo unikalų „Cloudinary“ IDpartners/radisson_blu_logo
Tai viskas, ko jums reikia norint gauti vaizdą bet kokiu norimu formatu, kokybe ir dydžiu.
Testavimas
Section titled “Testavimas”Užeikite į mūsųAPIskyrių ir pasirinkite API, su kuria norite dirbti.
API dokumentai
Section titled “API dokumentai”Mūsų dokumentacijos svetainė sukurta taip, kad joje būtų galima vykdyti API komandas.
Šiame pavyzdyje norite naudotiSearch Lookups (OAuth2)
API iškvietimas.
:::tip[Profesionalo patarimas]
Kad būtų lengviau naudoti, integratoriams rekomenduojame naudoti galinius taškus, kuriuos mes nurodome kaipOAuth2
Tie galiniai punktai žino, kad reikia tikėtis API iškvietimų, ir jau žino, kurioje paskyroje esate, todėl jums nereikia nurodyti.companyIdentifier
jūsų URL adresuose.
:::
- Naudokite Paieškos API norint gauti kelionių kryptis arba viešbučius.
- Kairiojoje naršymo juostoje spustelėkite
Authentication
. - Įveskite savo kliento ID ir kliento paslaptį ir spustelėkite
Get TOKEN
mygtukas. - Jei jūsų prisijungimo duomenys galioja, matysite, kad jūsų API raktas buvo pritaikytas.
- Dabar galite išbandyti paieškos galinį tašką.
Paštininkas
Section titled “Paštininkas”Tą patį galite padaryti ir su „Postman“.
- Atsisiųsti Paštininkas.
- Spustelėkite
Download OpenAPI spec
nuo viršaus Paieškos API puslapis. - Importuokite jį į „Postman“.
- Jei importavote kaip naują rinkinį, vadinamą
Wink API
, spustelėkite horizontalų daugtaškį (3 taškus) šalia kolekcijos pavadinimo ir spustelėkiteEdit
. - Į
Authorization tab
, nustatykiteAuth type
į OAuth2. - Nustatykite lauką
Add auth data to
įRequest headers
. - Nustatykite lauką
Header prefix
įBearer
. - Nustatykite lauką
Token Name
kaip norite pavadinti išsaugotą prieigos raktą „Postman“ programoje. Pvz., „Wink Staging“. - Nustatykite lauką
Grant type
įClient Credentials
. - Nustatykite lauką
Access token URL
į https://staging-iam.wink.travel/oauth2/token. - Nustatykite lauką
Client ID
kliento ID, kurį padėjo sukurti jūsų programėlė. - Nustatykite lauką
Client Secret
kliento paslapčiai, kurią padėjo sukurti jūsų programėlė. - Nustatykite lauką
Scope
įinventory.read inventory.write inventory.remove
Tai visos taikymo sritys, kurių jums reikės „Wink“. - Nustatykite lauką
Client Authentication
įSend as Basic Auth header
. - Spustelėkite
Get New Access Token
mygtuką, kad gautumėte savo prieigos raktą ir jį išsaugotumėte. - Visiems API iškvietimams iš „Wink“ API kolekcijos įsitikinkite, kad autentifikavimo skirtuke nurodyta
Inherit auth from parent
taigi jūsų prieigos raktas įtraukiamas į kiekvieną skambutį.
:::tip[Profesionalo patarimas] Rekomenduojama serverio domeną, kliento ID ir kliento slaptąjį raktą paversti aplinkos kintamaisiais. Tokiu būdu galėsite lengvai perjungti tarp testavimo ir gamybos aplinkų ir pakartotinai naudoti visas sukurtas operacijas. :::