Aeg ja vormingud

JSON ja tekst

Päringu ja vastuse kehad on JSON-vormingus, kodeeringus UTF-8 ja päisega Content-Type: application/json. Failide üleslaadimisel kasutatakse vormingut multipart/form-data.
Väljade nimed ja enum-väärtused on kujul snake_case: next_retry_at, index_failed.
Veateated ja API tekstid on inglise keeles. Teie kirjutatud tekstid, näiteks kaartide pealkirjad, tagastatakse mis tahes keeles täpselt nii, nagu need kirjutasite.

Ajahetked

Iga ajahetk on RFC 3339 ajatempel UTC-s:

{"created_at": "2026-10-24T10:00:00Z"}

Uuemad väljad kasutavad lühikest kuju lõpuga Z, nagu ülal.
Mõned varem olemas olnud väljad kasutavad kuju 2026-10-24T10:00:00.123456+00:00, kus sekundi murdosal on kuni kuus numbrit. See on sama hetk UTC-s. Parsige mõlemat kuju standardse RFC 3339 parseriga; ärge võrrelge ajatempleid stringidena.
Iga väli, mille nimi lõpeb liitega _at, on ajatempel.

Teie saadetavad ajahetked peavad sisaldama ajavööndi nihet: kas Z või numbrilist nihet, näiteks +02:00. Nihketa ajahetk on mitmetähenduslik ja tagastab 422 koodiga validation.failed. Sursa teisendab iga saadud ajahetke UTC-sse.

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

Päringustringis tuleb märk + kirjutada kujul %2B, muidu loetakse see tühikuks. URL-kodeerige ajaväärtused või kasutage tähist Z.

Kuupäevad, kestused ja arvud

Liik	Kuju	Näide
Kuupäev ilma kellaajata	`YYYY-MM-DD` väljal, mille nimi lõpeb liitega `_date`	`"due_date": "2026-11-01"`
Kestus	Täisarv, ühik on välja nimes	`"interval_days": 90`, `"timeout_seconds": 30`
Arv	Täisarv väljal, mille nimi lõpeb liitega `_count`	`"part_count": 12`
Tõene või väär	Tõeväärtus, mille nimi on omadussõna ilma eesliiteta `is_`	`"active": true`, `"sensitive": false`

Rahasummad

Finantsvastustes on summad kümnendarvudena kirjutatud stringid, näiteks "1250.00", mitte kunagi ujukomaarvud, et täpsus ei läheks kaduma. Valuuta on eraldi väli ISO 4217 koodiga, näiteks "EUR". Parsige summad oma programmeerimiskeele kümnendarvu tüübiga.

ID-d

ID-d on olenevalt objektist stringid või täisarvud. Vt Objektide ID-d.

Enum-väärtused

Kindla väärtuste hulgaga väljad, näiteks olek, on stringid. Iga enum-väli vastuses võib hilisemas versioonis saada uusi väärtusi: käsitlege tundmatut väärtust kui „muu“. Vt Versioonid ja ühilduvus.

Null ja puuduvad väljad

null tähendab „väärtus puudub“: vastutajata kaardil on "owner_id": null.
Väli võib vastusest puududa, kui see ei kehti selle objekti või selle päringu kohta. API teatmik märgib, millised väljad on alati olemas.
Päringus PATCH säilitab väli, mille jätate välja, oma väärtuse. Välja tühjendamiseks saatke null, kui teatmik ütleb, et null on lubatud.