Kaip sukurti ir atšaukti API raktą?

API raktai kuriami ir atšaukiami nustatymų skiltyje API. Slaptasis raktas parodomas vieną kartą, todėl svarbiausias yra kopijavimo žingsnis.

Raktai priklauso įmonei, o ne juos sukūrusiam žmogui – jungtis veikia ir tada, kai darbuotojas išeina.

Prieš pradedant

• Raktus tvarko tik įmonės administratorius. Nariui skiltis API nerodoma, o atvėrus adresą tiesiogiai matoma vien API raktus gali valdyti tik įmonės administratoriai. Paties raktų sąrašo narys nemato – žr. Kuo skiriasi administratorius ir narys?.
• Raktas skirtas jau esamai jungčiai. Pačios integracijos jis nesukuria – žr. Kas yra INVOX API?.
• Iš anksto pasiruoškite, kur raktą įrašysite. Uždarant langą niekas neklausiama, o antrą kartą raktas neberodomas.

Žingsniai

1. Nustatymuose spauskite skiltį API.

   

   Bus parodytas raktų sąrašas. Kol raktų nėra, rodoma API raktų dar nėra. Sąrašo viršuje yra nuoroda API dokumentacija.

2. Spauskite Sukurti raktą.

   

   Atsidarys langas Sukurti API raktą. Jo pradžioje rašoma Slaptasis raktas parodomas vieną kartą iškart po sukūrimo. Išsaugokite jį savo integracijoje prieš uždarydami langą.

3. Lauke Pavadinimas įrašykite, kuriai jungčiai raktas skirtas.

   

   Pavadinimas privalomas, iki 100 simbolių. Lauke rodomas pavyzdys pvz. Rivile jungtis. Vėliau šis pavadinimas matomas sąraše ir atšaukimo lange.

4. Dalyje Teisės pažymėkite, ką raktas galės daryti.

   
   • Skaityti — suteikiama visada. Šio langelio išjungti negalima.
   • Rašyti — keisti sąskaitų duomenis. Reikalinga tik tada, kai jungtis pati keičia duomenis INVOX.
   • Eksportuoti — generuoti eksporto failus. Reikalinga tik tada, kai jungtis užsako eksporto failus.

   Iš pradžių pažymėta tik Skaityti. Duomenis vien skaitančiai jungčiai abu kitus langelius palikite nepažymėtus.

5. Laikinam raktui lauke Galioja iki įrašykite datą.

   

   Data rašoma metų, mėnesio ir dienos tvarka, pavyzdžiui, 2026-12-31. Nuolatiniam raktui lauką palikite tuščią: Palikite tuščią, jei raktas turėtų galioti neribotai.

6. Lango apačioje spauskite Sukurti raktą.

   Mygtukas neaktyvus, kol neįrašytas pavadinimas ir kol data neatitinka formato. Atsidarys langas su rakto pavadinimu antraštėje ir pačiu slaptuoju raktu. Jame rodoma Nukopijuokite slaptąjį raktą dabar — jis nesaugomas ir daugiau nebus parodytas. Praradus jį, teks sukurti naują.

7. Spauskite kopijavimo piktogramą lauko dešinėje.

   Patvirtinimo užrašo nebus – dviem sekundėms piktograma pasikeičia į varnelę. Prieš uždarydami langą, įrašykite raktą į jungtį. Tik tada spauskite Baigta.

Ką rodo raktų sąrašas

Sąrašo stulpeliai: Pavadinimas, Raktas, Teisės, Sukurta, Paskutinį kartą naudota ir Galioja iki.

Stulpelyje Raktas rodoma tik rakto pradžia ir paskutiniai keturi simboliai. Viso rakto sąraše nėra ir nebus.

Stulpelyje Teisės teisės rodomos angliškai: read, write ir export. Tai tos pačios teisės, kurios kūrimo lange vadinamos Skaityti, Rašyti ir Eksportuoti.

Stulpelis Paskutinį kartą naudota parodo, ar raktas dar dirba. Nenaudotam raktui rodoma Niekada. Žyma atnaujinama ne dažniau kaip kartą per minutę, todėl ką tik įvykusi užklausa gali dar nesimatyti.

Neribotai galiojančiam raktui stulpelyje Galioja iki rodoma Neribotai.

Kaip saugoti raktą

• Kiekvienai jungčiai kurkite atskirą raktą. Raktų skaičius neribojamas, o atšaukus vieną, kitos jungtys dirba toliau.
• Suteikite tik tas teises, kurių jungčiai iš tikrųjų reikia.
• Laikinai jungčiai nurodykite galiojimo datą.
• Rakto nesiųskite el. paštu ir nedėkite į bendrus dokumentus.
• Įtarę, kad raktas nutekėjo, sukurkite naują ir senąjį atšaukite.

Kaip atšaukti raktą

Atšaukimas galioja nedelsiant ir yra negrįžtamas.

Pirmiausia sąraše pažiūrėkite stulpelį Paskutinį kartą naudota. Taip pamatysite, ar raktas dar naudojamas.

Rakto eilutėje spauskite Atšaukti. Atsidarys langas Atšaukti šį raktą?. Jame nurodomas rakto pavadinimas ir įspėjama, kad raktas nustos veikti nedelsiant, atkurti jo nebus galima, o visos tą raktą naudojančios jungtys nustos veikti.

Lange yra du mygtukai su tuo pačiu užrašu Atšaukti. Atšaukimą patvirtina raudonasis, esantis dešinėje. Kairysis tik uždaro langą.

Patvirtinus rodoma Raktas atšauktas. Eilutė iš sąrašo nedingsta: prie pavadinimo atsiranda žyma Atšauktas, o atšaukimo mygtuko nebelieka.

Nuo tos akimirkos tą raktą naudojančios užklausos gauna 401 su kodu API_KEY_REVOKED. Pasibaigus galiojimo datai grąžinamas kodas API_KEY_EXPIRED. Šie pranešimai atkeliauja angliškai, nes tai mašininis kanalas.

Ką daryti, jei nepavyko?

• Nustatymuose nėra skilties API. Ją mato tik administratorius. Atvėrus adresą tiesiogiai, rodoma API raktus gali valdyti tik įmonės administratoriai. Kreipkitės į savo įmonės administratorių.
• Rodomas pranešimas Nepavyko sukurti rakto. Dažniausia priežastis – jau praėjusi galiojimo data. Pranešime tai nenurodoma, todėl pirmiausia patikrinkite metus lauke Galioja iki.
• Rodomas pranešimas Naudokite formatą MMMM-MM-DD arba palikite tuščią, jei raktas turėtų galioti neribotai. Data įrašyta netinkamu formatu arba tokios dienos nėra. Įrašykite ją metų, mėnesio ir dienos tvarka.
• Langas uždarytas nenukopijavus rakto. Rakto atkurti nebegalima. Sukurkite naują raktą, o senąjį atšaukite.
• Jungtis gauna 403 su kodu INSUFFICIENT_SCOPE. Raktui trūksta teisės. Sukurkite naują raktą su reikiama teise ir atšaukite senąjį.
• Rodomas pranešimas Nepavyko atšaukti rakto. Pabandykite dar kartą. Jei kartojasi, rašykite support@invox.lt.

Susiję straipsniai

• Kas yra INVOX API?
• Kaip nustatyti webhook adresą?
• Kuo skiriasi administratorius ir narys?
• Kaip pakeisti sistemos nustatymus?