Uusi REST OpenAPI kehittäjille

Johdanto

Tervetuloa uuteen REST-sovellusliittymään, jonka olemme ottaneet käyttöön auttaaksemme sinua hallitsemaan yhteystietoja, yrityksiä, tilausluetteloita ja tunnisteita Vine-tietokannassasi. Vine REST API on käyttöliittymä, joka käyttää HTTP-pyyntöjä (GET, PUT, POST ja DELETE) ollakseen vuorovaikutuksessa Vine-tietokannan kanssa.

Näin alkuun

Vine Rest API on kaikkien Vine MA -käyttäjien käytettävissä.  Tiettyjen lisäominaisuuksien, kuten tekoälytoimintojen, saatavuus vaihtelee Vine MA -paketin mukaan. Ennen Vine Rest APIn käyttämistä vaaditaan autentikointi, koska tunnistamattomat käyttäjät eivät voi tehdä pyyntöjä.

Rajapinta sijaitsee osoitteessa https://vine.eu/api/rest/ma/v1/

Tunnistautuminen

Vine Rest API:ssa autentikointi alkaa LOGIN-pyynnöllä, joka luo bearer-tokenin seuraavia REST-kutsuja varten.

1. Ensimmäinen autentikointi käyttäen LOGIN-kutsua

Käytä LOGIN-pyyntöä Vine API -avaimella autentikointiin Vine Rest API:iin. Onnistunut LOGIN-pyyntö palauttaa tunnuksen tulevia kutsuja varten.

curl -X GET -H "x-api-key:A92330D0425211ECA7C5454B9025CC97-13B0B98D-618C0D00" https://vine.eu/api/rest/ma/v1/login

Tämä palauttaa bearer-tokenin, kuten:

"5a80da50-055f-11ee-936f-2fa22a85c2c5"

Sisällytä tämä token seuraavien API-pyyntöjesi headereihin.

Huomaa: On erittäin suositeltavaa käyttää x-api-key turvallisuuden parantamiseksi ja koodin toiminnan varmistamiseksi, vaikka salasana muuttuisi.

curl -X GET -u "demo@vine.eu:demo" https://vine.eu/api/rest/ma/v1/login

curl -X POST -H "Content-Type: application/json" -d '{"username":"demo@vine.eu","password":"demo"}' https://vine.eu/api/rest/ma/v1/login

2. Tokenipohjainen autentikointi

Käytä sisäänkirjautumispyynnön jälkeen bearer-tokenia seuraavissa API-kutsuissa headerissa seuraavasti:

curl -X GET -H "Authorization: Bearer f4d04630-0565-11ee-936f-2fa22a85c2c5" https://vine.eu/api/rest/ma/v1/contacts

Tunnus on voimassa 1 tunnin ajan viimeisen käytön jälkeen.

Sisältötyypit

Vine REST API -palvelu hyväksyy vain pyynnöt, joiden Content-Type -header on asetettu arvoon application/json sekä POST- että PUT-pyynnöille. Vine REST -palvelu käyttää suurimmalle osalle vastauksista sisältötyyppiä application/json. Tietyissä mediaan liittyvissä pyynnöissä, kuten kuvan generointi, käytetään kuitenkin sisältötyyppiä image/jpeg. Asiakassovellusten tulee käsitellä näitä sisältötyyppejä palautetun Content-Type-headerin perusteella. Kutsuissa ei tarvitse asettaa Accept -headeria, koska Vine REST -palvelu jättää sen huomioimatta pyynnön käsittelyn aikana.

Dokumentaatio

Lisätietoja päätepisteistä, parametreista, pyyntö-/vastausmuodoista ja autentikointi-menetelmistä löytyy Vine REST API -dokumentaatiossa ja sen Open API -määrityksessä.