यह दस्तावेज़ निम्नलिखित क्रियाओं के लिए सभी API विधियों का वर्णन करता है:
API केवल IP पतों की सीमित सूची से अनुरोध स्वीकार करता है (उदाहरण के लिए, किसी ग्राहक की खाता साइट या बैक ऑफिस साइट से)।
किसी आईपी पते से एपीआई के लिए कोई भी अनुरोध जो अनुमत सूची में नहीं है, उसे अस्वीकार कर दिया जाएगा।
यह एपीआई पर डीडीओएस हमलों को रोकने के लिए किया जाता है, अनुरोधों और हैकर प्रयोगों को गलत साबित करने का प्रयास करता है।
उपयोगकर्ता हमेशा प्लेटफॉर्म की सार्वजनिक साइट (ग्राहक कार्यालय या बैक ऑफिस) तक पहुंचते हैं, और यह साइट स्वयं प्लेटफॉर्म के एपीआई से आवश्यक डेटा का अनुरोध करती है। चूंकि साइट का IP पता निश्चित है, यह अनुमत सूची में होगा।
सभी API अनुरोध निम्न HTTP विधियों का उपयोग करके किए जाते हैं:
एपीआई के प्रत्येक अनुभाग में एक यूआरएल होता है जिसमें प्रासंगिक डेटा प्राप्त करने के लिए अनुरोध किया जाता है।
प्रत्येक URL के सामने HTTP अनुरोध विधि निर्दिष्ट की जाती है।
प्रत्येक एपीआई अनुरोध में हमेशा 4 चर होने चाहिए:
यदि अनुरोध सफल होता है, तो एपीआई हमेशा दो चर लौटाता है:
यदि अनुरोध विफल रहता है, तो एपीआई चर दिखाता है:
प्रत्येक एपीआई अनुरोध में एक हैश चर होना चाहिए जो अनुरोध का डिजिटल हस्ताक्षर है।
hash = md5($json . $time . $salt)
