Pereiti prie turinio
Sursa Developers

Laikas ir formatai

JSON ir tekstas

  • Užklausų ir atsakų turinys – JSON UTF-8 koduote, su Content-Type: application/json. Failai įkeliami kaip multipart/form-data.
  • Laukų pavadinimai ir išvardijimų reikšmės rašomi snake_case forma: next_retry_at, index_failed.
  • Klaidų pranešimai ir API tekstai yra anglų kalba. Jūsų parašyti tekstai, pavyzdžiui, kortelių pavadinimai, grąžinami tokie, kokius parašėte, bet kuria kalba.

Laikas

Kiekvienas laikas – RFC 3339 laiko žymė UTC:

{"created_at": "2026-10-24T10:00:00Z"}
  • Naujesni laukai naudoja trumpąją formą su Z, kaip pavyzdyje.
  • Kai kurie anksčiau buvę laukai naudoja formą 2026-10-24T10:00:00.123456+00:00, su ne daugiau kaip šešiais sekundės trupmenos skaitmenimis. Tai tas pats momentas UTC. Abi formas nuskaitykite standartine RFC 3339 analizės priemone; laiko žymių nelyginkite kaip eilučių.
  • Kiekvienas laukas, kurio pavadinimas baigiasi _at, yra laiko žymė.

Jūsų siunčiamame laike turi būti laiko juostos poslinkis – Z arba skaitinis poslinkis, pavyzdžiui, +02:00. Laikas be poslinkio yra dviprasmiškas ir grąžina 422 su kodu validation.failed. Sursa kiekvieną gautą laiką perskaičiuoja į UTC.

const since = new Date(Date.now() - 24 * 3600 * 1000).toISOString(); // "2026-10-23T10:00:00.000Z"

Užklausos eilutėje + reikia rašyti kaip %2B, kitaip jis skaitomas kaip tarpas. Laiko reikšmes koduokite URL kodavimu arba naudokite Z.

Datos, trukmės ir kiekiai

RūšisFormaPavyzdys
Data be laikoYYYY-MM-DD, lauke, kurio pavadinimas baigiasi _date"due_date": "2026-11-01"
TrukmėSveikasis skaičius, matavimo vienetas – lauko pavadinime"interval_days": 90, "timeout_seconds": 30
KiekisSveikasis skaičius, lauke, kurio pavadinimas baigiasi _count"part_count": 12
Taip arba neLoginė reikšmė, pavadinta būdvardžiu be is_"active": true, "sensitive": false

Pinigų sumos

Sumos finansiniuose atsakuose yra dešimtainės eilutės, pavyzdžiui, "1250.00", niekada ne slankiojo kablelio skaičiai, kad nebūtų prarastas tikslumas. Valiuta – atskiras laukas su ISO 4217 kodu, pavyzdžiui, "EUR". Sumas nuskaitykite savo kalbos dešimtainiu tipu.

ID

ID yra eilutės arba sveikieji skaičiai, priklausomai nuo objekto. Žr. Objektų ID.

Išvardijimai

Laukai su fiksuotu reikšmių rinkiniu, pavyzdžiui, būsena, yra eilutės. Kiekvienas atsako išvardijimas vėlesnėje versijoje gali gauti naujų reikšmių: nežinomą reikšmę vertinkite kaip „kita“. Žr. Versijos ir suderinamumas.

Null ir trūkstami laukai

  • null reiškia „reikšmės nėra“: kortelė be atsakingo asmens turi "owner_id": null.
  • Lauko atsake gali nebūti, kai jis netaikomas šiam objektui ar šiai užklausai. API žinyne pažymėta, kurie laukai būna visada.
  • Užklausoje PATCH laukas, kurio nesiunčiate, išlaiko savo reikšmę. Siųskite null, jei norite lauką išvalyti, kai žinyne nurodyta, kad null leidžiama.