एपीआई संदर्भ।

प्रमाणीकरण

सभी अनुरोध बियरर टोकन के साथ प्रमाणित होते हैं Authorization शीर्षक. अपने Ajoxi कंसोल के एपीआई टैब से कुंजी उत्पन्न करें - उपयोग करें AJX_LIVE_… उत्पादन यातायात के लिए और AJX_TEST_… सैंडबॉक्स के लिए.

curl https://api.ajoxi.com/v1/calls \
  -H "Authorization: Bearer AJX_LIVE_XXXXX"

कोर समापनबिंदु

त्रुटियाँ एवं स्थिति कोड

प्रत्येक त्रुटि प्रतिक्रिया JSON को एक के साथ लौटाती है error.code और error.message. HTTP स्थिति कोड श्रेणी से मेल खाता है।

दर सीमा

मानक खातों को प्रति एपीआई कुंजी प्रति सेकंड 100 अनुरोधों पर सीमित किया गया है। एंटरप्राइज़ योजनाओं की कोई निश्चित सीमा नहीं है - हम आपके ट्रैफ़िक के अनुसार मापते हैं। प्रत्येक प्रतिक्रिया में तीन दर-सीमा शीर्षलेख शामिल होते हैं:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 87
X-RateLimit-Reset: 1715800000

जब सीमा पार हो जाती है तो आपको a के साथ 429 प्रतिक्रिया प्राप्त होती है Retry-After सेकंड में हेडर. एसडीके क्लाइंट इन हेडर के विरुद्ध स्वचालित रूप से घातीय बैकऑफ़ लागू करते हैं।

पृष्ठ पर अंक लगाना

सूची समापन बिंदु डिफ़ॉल्ट रूप से प्रति पृष्ठ अधिकतम 50 आइटम लौटाते हैं (200 तक कॉन्फ़िगर करने योग्य)। ?limit=200). प्रत्येक प्रतिक्रिया में एक शामिल है next_cursor - इसे इस रूप में वापस पास करें ?cursor=… अगला पृष्ठ पुनः प्राप्त करने के लिए. कब next_cursor शून्य है, आप अंत तक पहुंच गए हैं.

{
  "data": [ ... ],
  "next_cursor": "Y3Vyc29yX2FmMmI...",
  "has_more": true
}

वेबहुक

हस्ताक्षरित HTTPS POSTs के माध्यम से प्लेटफ़ॉर्म ईवेंट की सदस्यता लें। प्रत्येक वेबहुक अनुरोध में एक शामिल है X-Ajoxi-Signature हेडर - अपने वेबहुक सीक्रेट का उपयोग करके इसे कच्चे अनुरोध निकाय पर HMAC-SHA256 के रूप में सत्यापित करें।

विफल डिलीवरी 24 घंटे तक घातीय बैकऑफ़ के साथ पुनः प्रयास करें। अंतिम प्रयास के बाद, ईवेंट को एक मृत-अक्षर कतार में ले जाया जाता है जिसे आप कंसोल से पुनः चला सकते हैं।

संस्करण

वर्तमान स्थिर संस्करण है v1. ब्रेकिंग परिवर्तन एक नए उपसर्ग के अंतर्गत भेजे जाते हैं (/v2/, आदि) - मौजूदा संस्करण के अंदर कभी नहीं। अस्वीकृत संस्करण उत्तराधिकारी जहाजों के बाद कम से कम 18 महीने तक उपलब्ध रहते हैं, सूर्यास्त से पहले 6 महीने की ईमेल चेतावनी के साथ।

एसडीके

प्रथम-पक्ष SDK Node.js, Python, Go और Ruby के लिए उपलब्ध हैं। प्रत्येक जहाज टाइप किए गए क्लाइंट, पुनः प्रयास तर्क और ए के साथ आता है verifyWebhook() सहायक.