Siirry sisältöön
Sursa Developers

Ajat ja muodot

JSON ja teksti

  • Pyyntöjen ja vastausten rungot ovat JSON-muodossa UTF-8-koodauksella, ja niissä on Content-Type: application/json. Tiedostojen lataukset käyttävät multipart/form-data-muotoa.
  • Kenttien nimet ja enum-arvot ovat snake_case-muodossa: next_retry_at, index_failed.
  • Virheilmoitukset ja API:n omat tekstit ovat englanniksi. Itse kirjoittamasi tekstit, kuten korttien otsikot, palautetaan sellaisina kuin kirjoitit ne, millä kielellä tahansa.

Ajat

Jokainen aika on RFC 3339 -aikaleima UTC-ajassa:

{"created_at": "2026-10-24T10:00:00Z"}
  • Uudemmat kentät käyttävät lyhyttä muotoa, jonka lopussa on Z, kuten yllä.
  • Jotkin aiemmin olemassa olleet kentät käyttävät muotoa 2026-10-24T10:00:00.123456+00:00, jossa sekunnin murto-osalla on enintään kuusi numeroa. Se on sama hetki UTC-ajassa. Jäsennä molemmat muodot tavallisella RFC 3339 -jäsentimellä; älä vertaa aikaleimoja merkkijonoina.
  • Jokainen kenttä, jonka nimen lopussa on _at, on aikaleima.

Lähettämissäsi ajoissa täytyy olla aikavyöhykkeen siirtymä, joko Z tai numeerinen siirtymä, kuten +02:00. Aika ilman siirtymää on monitulkintainen ja palauttaa 422-vastauksen ja koodin validation.failed. Sursa muuntaa jokaisen vastaanottamansa ajan UTC-aikaan.

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

Kyselymerkkijonossa + täytyy kirjoittaa muodossa %2B, muuten se luetaan välilyönniksi. URL-koodaa aika-arvot tai käytä Z-merkkiä.

Päivämäärät, kestot ja lukumäärät

LajiMuotoEsimerkki
Päivämäärä ilman kellonaikaaYYYY-MM-DD kentässä, jonka nimen lopussa on _date"due_date": "2026-11-01"
KestoKokonaisluku; yksikkö on kentän nimessä"interval_days": 90, "timeout_seconds": 30
LukumääräKokonaisluku kentässä, jonka nimen lopussa on _count"part_count": 12
Tosi tai epätosiTotuusarvo, jonka nimenä on adjektiivi ilman is_-etuliitettä"active": true, "sensitive": false

Rahasummat

Talousvastausten summat ovat desimaalilukuja sisältäviä merkkijonoja, kuten "1250.00", eivät koskaan liukulukuja, jotta tarkkuutta ei menetetä. Valuutta on erillinen kenttä, jossa on ISO 4217 -koodi, kuten "EUR". Jäsennä summat käyttämäsi ohjelmointikielen desimaalityypillä.

Tunnukset

Tunnukset ovat objektista riippuen merkkijonoja tai kokonaislukuja. Ks. Objektien tunnukset.

Luetteloarvot

Kentät, joilla on kiinteä arvojoukko, kuten tila, ovat merkkijonoja. Mikä tahansa vastauksen luetteloarvokenttä voi saada uusia arvoja myöhemmässä versiossa: käsittele tuntematonta arvoa kuten arvoa ”muu”. Ks. Versiot ja yhteensopivuus.

Null-arvo ja puuttuvat kentät

  • null tarkoittaa ”ei arvoa”: kortilla, jolla ei ole omistajaa, on "owner_id": null.
  • Kenttä voi puuttua vastauksesta, kun se ei koske tätä objektia tai tätä pyyntöä. API-viite kertoo, mitkä kentät ovat aina mukana.
  • PATCH-pyynnössä kenttä, jonka jätät pois, säilyttää arvonsa. Lähetä null, jos haluat tyhjentää kentän, jonka kohdalla viite kertoo null-arvon olevan sallittu.