Julkisen API:n käyttäminen

Upsellrin julkinen API antaa pääsyn master dataasi, tuotteisiisi, lähteisiisi ja työnkulkuihisi omista työkaluistasi. Se sisältyy Enterprise-pakettiin.

Olennaiset tiedot

• Perusosoite: https://api.upsellr.io/v2
• Todennus: jokaisessa pyynnössä on Authorization-otsake, jonka arvo on Bearer ja sen perässä avaimesi. Katso API-avainten luominen ja hallinta.
• Dokumentaatio: täydellinen viiteaineisto esimerkkeineen on julkaistu osoitteessa docs.upsellr.io.

Kutsut vain palvelimelta

API:a kutsutaan palvelimelta, ei koskaan selaimesta: se ei vastaa verkkosivun lähettämiin pyyntöihin. Näin vältetään myös avaimesi paljastuminen sivun koodissa.

Nopeusrajat

Rajat koskevat koko organisaatiota kaikki avaimet yhteensä.

Pyyntötyyppi	Minuutissa	Purske
Lukemiset	200	30
Kirjoitukset	60	10
Raskaat kirjoitukset: tuotteiden luominen, tiedoston tallentaminen, työnkulun käynnistäminen	20	5
Tuotteiden haku ja lukeminen	60	5

Rajan ylittyessä API vastaa koodilla 429 ja Retry-After-otsakkeella, joka kertoo sekunteina, milloin voi yrittää uudelleen.

Pyyntötunniste

Jokaisessa vastauksessa on X-Request-Id-otsake. Jos pyyntö epäonnistuu odottamattomasti, kirjoita tunniste muistiin ja välitä se tuelle: sen avulla kutsusi löydetään tarkasti.

Hyvä tietää

• Tiettyihin IP-osoitteisiin tai User-Agenteihin rajattu avain hylätään kaikista muista lähteistä.
• Liian monta pyyntöä virheellisellä avaimella samasta osoitteesta johtaa tilapäiseen estoon, josta kertoo koodi 429.
• Avain toimii vain käyttöoikeuksiensa rajoissa: käyttöoikeuksien ulkopuolinen pyyntö hylätään.
• Työnkulun käynnistäminen API:n kautta kuluttaa krediittejä samoin kuin sovelluksesta.
• Jos haluat tiedon suorituksen päättymisestä kyselemättä API:a jatkuvasti, käytä webhookeja.
• Onko sinulla kysyttävää? Ota meihin yhteyttä tai käytä sovelluksen Report a bug -painiketta ja liitä mukaan pyyntötunniste.