İçeriğe geç
Sursa Developers

Zaman ve biçimler

JSON ve metin

  • İstek ve yanıt gövdeleri UTF-8 kodlamalı JSON’dur ve Content-Type: application/json ile gönderilir. Dosya yüklemelerinde multipart/form-data kullanılır.
  • Alan adları ve enum değerleri snake_case biçimindedir: next_retry_at, index_failed.
  • Hata iletileri ve API’nin metinleri İngilizcedir. Kart başlıkları gibi sizin yazdığınız metinler, hangi dilde olursa olsun yazdığınız gibi döndürülür.

Zamanlar

Her zaman değeri, UTC’de bir RFC 3339 zaman damgasıdır:

{"created_at": "2026-10-24T10:00:00Z"}
  • Daha yeni alanlar, yukarıdaki gibi Z ile biten kısa biçimi kullanır.
  • Daha önce var olan bazı alanlar, saniyenin altı basamağa kadar kesirleriyle 2026-10-24T10:00:00.123456+00:00 biçimini kullanır. Bu da UTC’de aynı andır. İki biçimi de standart bir RFC 3339 ayrıştırıcısıyla ayrıştırın; zaman damgalarını dize olarak karşılaştırmayın.
  • Adı _at ile biten her alan bir zaman damgasıdır.

Gönderdiğiniz zamanlar bir saat dilimi farkı içermelidir: ya Z ya da +02:00 gibi sayısal bir fark. Farkı belirtilmemiş bir zaman belirsizdir ve validation.failed koduyla 422 döndürür. Sursa aldığı her zamanı UTC’ye çevirir.

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

Sorgu dizesinde + işareti %2B olarak yazılmalıdır, aksi hâlde boşluk olarak okunur. Zaman değerlerini URL kodlamasıyla yazın ya da Z kullanın.

Tarihler, süreler ve sayılar

TürBiçimÖrnek
Saatsiz tarih_date ile biten bir alanda YYYY-MM-DD"due_date": "2026-11-01"
SüreBirimi alan adında belirtilen bir tam sayı"interval_days": 90, "timeout_seconds": 30
Adet_count ile biten bir alanda bir tam sayı"part_count": 12
Doğru ya da yanlışis_ olmadan bir sıfatla adlandırılmış mantıksal değer"active": true, "sensitive": false

Para tutarları

Finansal yanıtlardaki tutarlar, hiçbir hassasiyet kaybolmasın diye kayan noktalı sayı olarak değil, "1250.00" gibi ondalık dizeler olarak yazılır. Para birimi, ISO 4217 kodunu (örneğin "EUR") içeren ayrı bir alandır. Tutarları kullandığınız dildeki ondalık bir türle ayrıştırın.

Kimlikler

Kimlikler, nesneye göre dize ya da tam sayıdır. Nesne kimlikleri sayfasına bakın.

Sabit değer listeleri

Durum gibi sabit bir değer kümesine sahip alanlar dizedir. Yanıttaki her sabit değer listesi sonraki bir sürümde yeni değerler alabilir: bilmediğiniz bir değeri “diğer” olarak ele alın. Sürümler ve uyumluluk sayfasına bakın.

Null ve eksik alanlar

  • null “değer yok” anlamına gelir: sorumlusu olmayan bir kartta "owner_id": null bulunur.
  • Bir alan, bu nesne ya da bu istek için geçerli olmadığında yanıtta yer almayabilir. API başvurusu, hangi alanların her zaman bulunduğunu belirtir.
  • PATCH isteğinde göndermediğiniz bir alan değerini korur. Bir alanı temizlemek için, başvuruda null değerine izin verildiği belirtilen alanlara null gönderin.