समय और फ़ॉर्मेट
JSON और टेक्स्ट
- रिक्वेस्ट और रिस्पॉन्स बॉडी UTF-8 में JSON होती हैं,
Content-Type: application/jsonके साथ। फ़ाइल अपलोडmultipart/form-dataइस्तेमाल करते हैं। - फ़ील्ड के नाम और enum मान
snake_caseमें होते हैं:next_retry_at,index_failed। - एरर संदेश और API के टेक्स्ट अंग्रेज़ी में होते हैं। आपके लिखे टेक्स्ट, जैसे कार्ड के शीर्षक, वैसे ही लौटाए जाते हैं जैसे आपने लिखे थे, किसी भी भाषा में।
समय
हर समय UTC में RFC 3339 टाइमस्टैम्प होता है:
{"created_at": "2026-10-24T10:00:00Z"}
- नए फ़ील्ड ऊपर की तरह
Zवाला छोटा रूप इस्तेमाल करते हैं। - पहले से मौजूद कुछ फ़ील्ड
2026-10-24T10:00:00.123456+00:00रूप इस्तेमाल करते हैं, जिसमें सेकंड के भिन्न के छह अंक तक होते हैं। यह UTC में वही पल है। दोनों रूपों को किसी मानक RFC 3339 पार्सर से पार्स करें; टाइमस्टैम्प की तुलना स्ट्रिंग की तरह न करें। - जिस फ़ील्ड का नाम
_atपर ख़त्म होता है, वह टाइमस्टैम्प है।
आपके भेजे समय में टाइम ज़ोन ऑफ़सेट होना चाहिए, या तो Z या +02:00 जैसा संख्या वाला ऑफ़सेट। ऑफ़सेट के बिना समय
अस्पष्ट है और कोड validation.failed के साथ 422 लौटाता है। Sursa मिलने वाले हर
समय को UTC में बदल देता है।
const since = new Date(Date.now() - 24 * 3600 * 1000).toISOString(); // "2026-10-23T10:00:00.000Z"क्वेरी स्ट्रिंग में + को %2B लिखना ज़रूरी है, वरना उसे स्पेस पढ़ा जाता है। समय के मान URL-एनकोड करें, या Z
इस्तेमाल करें।
तारीख़ें, अवधि और गिनती
| प्रकार | रूप | उदाहरण |
|---|---|---|
| समय के बिना तारीख़ | YYYY-MM-DD, ऐसे फ़ील्ड में जिसका नाम _date पर ख़त्म होता है | "due_date": "2026-11-01" |
| अवधि | पूर्णांक, फ़ील्ड के नाम में इकाई के साथ | "interval_days": 90, "timeout_seconds": 30 |
| गिनती | पूर्णांक, ऐसे फ़ील्ड में जिसका नाम _count पर ख़त्म होता है | "part_count": 12 |
| सही या ग़लत | बूलियन, is_ के बिना विशेषण से नामित | "active": true, "sensitive": false |
रक़म
वित्तीय रिस्पॉन्स में रक़में दशमलव स्ट्रिंग होती हैं, जैसे "1250.00", फ़्लोटिंग-पॉइंट संख्याएँ कभी नहीं,
ताकि सटीकता न खोए। करेंसी अलग फ़ील्ड में ISO 4217 कोड के साथ होती है, जैसे "EUR"। रक़मों को अपनी भाषा के दशमलव
टाइप से पार्स करें।
ID
ID ऑब्जेक्ट के आधार पर स्ट्रिंग या पूर्णांक होती हैं। देखें ऑब्जेक्ट के ID।
Enum सूचियाँ
तय मानों वाले फ़ील्ड, जैसे स्टेटस, स्ट्रिंग होते हैं। रिस्पॉन्स की हर enum सूची में बाद के वर्शन में नए मान आ सकते हैं: जो मान आप नहीं जानते, उसे “अन्य” मानें। देखें वर्शन और संगतता।
null और ग़ायब फ़ील्ड
nullका मतलब है “कोई मान नहीं”: बिना ज़िम्मेदार व्यक्ति वाले कार्ड में"owner_id": nullहोता है।- कोई फ़ील्ड रिस्पॉन्स में तब ग़ायब हो सकता है, जब वह इस ऑब्जेक्ट या इस रिक्वेस्ट पर लागू नहीं होता। API रेफ़रेंस बताता है कि कौन-से फ़ील्ड हमेशा मौजूद रहते हैं।
PATCHमें जो फ़ील्ड आप छोड़ देते हैं, उसका मान वही रहता है। जहाँ रेफ़रेंस में लिखा है किnullमान्य है, वहाँ फ़ील्ड ख़ाली करने के लिएnullभेजें।