प्रमाणीकरण और सीमाएँ

API कुंजी इंटीग्रेशन (Integrations) सेक्शन में पाएँ।

क्षमताएँ

• इनवॉइस का प्रबंधन: बनाना, रद्द करना, स्थिति की जाँच
• भुगतानों का प्रबंधन: भुगतानों की सूची, भुगतान को इनवॉइस से जोड़ना
• आँकड़े: प्रोजेक्ट, अवधि, वॉलेट वग़ैरह के हिसाब से एकत्रित डेटा
• बिलिंग: प्रोजेक्ट की शुल्क दरें, बैलेंस

सीमाएँ

• अनुरोधों की रफ़्तार: हर कुंजी से ज़्यादा से ज़्यादा 1 अनुरोध प्रति सेकंड
• कुंजियों की संख्या: खाते में 10

अनुरोध का प्रमाणीकरण

हर API अनुरोध को अधिकृत करने के लिए अपनी API कुंजी Authorization हेडर में भेजें।

API अनुरोध में Authorization हेडर का उदाहरण:

curl -X POST https://api.bitsby.app/invoices/list \
  -H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay"

सर्वर का जवाब

API सर्वर हमेशा JSON में जवाब देता है। अनुरोध सफल हुआ या नहीं, यह result पैरामीटर से पहचानें।

सफल अनुरोध के जवाब का उदाहरण:

{
    "result": "success",
    "data": .....
}

त्रुटि के जवाब का उदाहरण:

{
    "result": "error",
    "data": "Requests too frequent"
}