Cene in pravica do uporabe

Dostop do API-ja je vezan na naročniško funkcijo ApiAccess. Vključena je v paketu Enterprise, na vseh drugih paketih pa je na voljo kot plačljiv dodatek. Klici, avtenticirani z API ključem, proti podjetju brez ApiAccess vrnejo HTTP 402 s code: "API_ACCESS_NOT_ENABLED", preden pridejo do kontrolerja.

Ta stran je avtoritativen vir za to, kateri paket potrebuje stranka vašega partnerskega izdelka. Marketinške strani (getlocco.com/sl/cene) opisujejo pakete v poslovnih izrazih; spodnja matrica je tisto, kar runtime dejansko preverja.

Pravilo

ApiAccess je vključen v paketu Enterprise.
Na vseh drugih paketih je ApiAccess na voljo kot plačljiv dodatek. Brez dodatka so zahtevki zavrnjeni z 402.
Preverjanje se izvede enkrat na zahtevek, po avtentikaciji in po tem, ko je glava X-Company-Id razrešena na ciljno podjetje. Zahtevek, ki prestane preverjanje, porabi slot v oknih omejitve zahtevkov; zahtevek, ki ne prestane, ne porabi.

Preverjanje temelji na ciljnem podjetju, razrešenem iz X-Company-Id, ne na uporabniku, ki je lastnik ključa. Uporabnik, ki pripada dvema podjetjema (enemu z ApiAccess, enemu brez), bo z istim ključem uspel proti upravičenemu najemniku in dobil 402 proti drugemu.

Matrica paketov

Paket	API dostop
Free	Dodatek
Business	Dodatek
Plus	Dodatek
Professional	Dodatek
Enterprise	Vključeno

Za odklep dostopa do API-ja lahko uporabniki bodisi nadgradijo na Enterprise (ki ApiAccess združuje s preostankom paketa) bodisi dodajo dodatek ApiAccess k svojemu obstoječemu paketu. Obe poti sta na voljo v locco spletni aplikaciji pod Nastavitve → Naročnina.

Odgovor 402

Ko ključ zadene podjetje, ki nima ApiAccess, partnerski API vrne HTTP 402 s kanonično ovojnico napake:

{
  "code": "API_ACCESS_NOT_ENABLED",
  "type": "PaymentRequired",
  "title": "<lokalizirano berljivo sporočilo>",
  "status": 402
}

code: stabilno. Partnerji filtrirajo po tem nizu. Konstanta je v katalogu napak.
type: stara kategorija, ohranjena zaradi združljivosti s SPA aplikacijo. Ne pogojujte logike z njo.
title: lokalizirano glede na glavo Accept-Language zahtevka (privzeto hr). Nikoli ne razčlenjujte. Formulacija ni stabilna med izdajami, dejansko besedilo pa prihaja iz datotek z viri partnerskega API-ja (SharedResource.resx / SharedResource.hr.resx).
status: odraža HTTP status. 402 Payment Required je standardna koda za pomanjkanje pravice do uporabe. Isti status industrija uporablja za “poverilnice so veljavne, vendar paket ne vključuje te površine”.

Content-Type je application/json. Odgovor je kratek: brez slovarja errors, brez podrobnosti po polju. Partner nima česa poskusiti znova z drugačnim vnosom. Edina rešitev je, da uporabnik nadgradi paket.

Priporočeno ravnanje partnerja

402 z partnerskega API-ja je napaka stanja uporabnika, ne prehodna napaka. Ponovljen poskus istega ključa proti istemu podjetju bo še naprej vračal 402, dokler uporabnik ne nadgradi paketa.

Razumno ravnanje odjemalca:

Ob 402 s code: "API_ACCESS_NOT_ENABLED" ustavite integracijsko zanko za to podjetje in v svojem vmesniku ali konzoli prikažite jasno sporočilo “locco paket tega uporabnika ne vključuje API dostopa”.
Ne zakasnite in ponavljajte. Stanje ni prehodno.
Če integracija pokriva več podjetij, izolirajte zid na neuspešno podjetje. Ostala podjetja na paketu Enterprise morajo še naprej delovati.

Za podroben opis vsake napake, ki jo lahko partnerski API odda, glejte katalog napak.

Povezano

Avtentikacija: bearer žetoni, glava X-Company-Id in rotacija ključev.
Napake: popoln katalog stabilnih strojno berljivih kod napak.
Omejitve zahtevkov: omejitve na sekundo, uro in dan na paketu Enterprise.