Autentifikacija

Kiekviena užklausa į F-sąskaita API autentifikuojama verslo prieigos raktu (Business token). Prieigos raktas identifikuoja vieną jūsų paskyros verslą, ir kiekviena sąskaita faktūra, išlaidų dokumentas ar profilis, su kuriuo dirbate, priklauso tam verslui.

Sukurkite prieigos raktą

1. Prisijunkite prie app.fsaskaita.lt kaip naudotojas, galintis valdyti verslą.
2. Atidarykite Nustatymai, tada Integracijos, tada API.
3. Suteikite prieigos raktui pavadinimą, iš kurio aišku, kur jis naudojamas, pavyzdžiui accounting-sync, ir sukurkite jį.
4. Iš karto nusikopijuokite prieigos raktą. Jis parodomas tik vieną kartą. Vėliau sąraše matomas tik jo pavadinimas.

Prieigos raktai pasiekiami tik planuose, kuriuose įtraukta API funkcija. Jei vietoj formos skiltyje rodomas pranešimas apie plano atnaujinimą, dabartinis planas jos neapima.

Naudokite prieigos raktą

Siųskite jį antraštėje Authorization ir visada prašykite JSON:

curl https://app.fsaskaita.lt/api/profile \
  -H "Authorization: Bearer $FSASKAITA_TOKEN" \
  -H "Accept: application/json"

Sėkmingas atsakymas aprašo verslą, kuriam priklauso prieigos raktas:

{
  "data": {
    "business_id": "9c1f7b2e-3a6d-4d5e-9f0a-2b7c8d9e0f11",
    "business_title": "Pavyzdys, MB",
    "business_type": "small_partnership",
    "address": "Gedimino pr. 1, Vilnius",
    "vat_code": "LT100001234567",
    "company_name": "Pavyzdys, MB",
    "company_code": "305000001"
  }
}

Jei verslas registruotas kaip individuali veikla, profilyje vietoj company_name ir company_code pateikiami individual_activity_id, first_name ir last_name.

Kodėl svarbi Accept antraštė

Programos klaidos bet kuriuo atveju grąžinamos JSON formatu. Tačiau be Accept: application/json trūkstamas arba panaikintas prieigos raktas gauna HTML peradresavimą į prisijungimo puslapį, o užklausų limitą viršijusi užklausa – HTML klaidos puslapį. Su šia antrašte gausite 401 {"message":"Unauthenticated."} ir 429 {"message":"Too Many Attempts."}.

Apimtis ir galiojimas

• Prieigos raktas suteikia pilną prieigą prie savo verslo. Atskirų teisių pagal galinius taškus nėra.
• Prieigos raktų galiojimas nesibaigia. Raktą panaikinsite ištrynę jį tame pačiame nustatymų puslapyje; užklausos su ištrintu raktu gauna 401.
• Jei jūsų paskyroje yra keli verslai, kiekvienam sukurkite atskirą prieigos raktą.
• Visi vieno verslo prieigos raktai dalijasi tuo pačiu 60 užklausų per minutę limitu.

Laikykite jį paslaptyje

Su prieigos raktu elkitės kaip su slaptažodžiu. Saugokite jį paslapčių tvarkyklėje arba aplinkos kintamajame, niekada – repozitorijoje ar naršyklės pusės programoje. Jei prieigos raktas nutekėjo, ištrinkite jį programėlėje ir sukurkite naują.