शुरू करें

API कुंजियों के साथ प्रमाणीकरण

मार्कडाउन के रूप में देखें OpenAPI स्पेक

दो प्राइसिंग एंडपॉइंट्स को छोड़कर हर एंडपॉइंट को Authorization हेडर में एक API कुंजी की आवश्यकता होती है।

POST /v1/messages HTTP/1.1
Host: bulksmsapi.cc
Authorization: Bearer bsa_live_7QzX2mW9kR4tB8nV1cJ6yP3sH5dL0aFe
Content-Type: application/json

कुंजियाँ बनाना

कुंजियाँ कंसोल के API कुंजी पेज पर बनाई जाती हैं। पेज पहले टॉप-अप को बैलेंस में जोड़ने के बाद खुलता है।
एक खाता 10 सक्रिय कुंजियाँ रख सकता है। प्रत्येक ऐप या एनवायरनमेंट को अपनी कुंजी और नाम दें, ताकि एक को दूसरों को छुए बिना बदला जा सके।
एक कुंजी bsa_live_ के बाद 32 अक्षर और अंक होते हैं। इसे एक बार दिखाया जाता है, जब इसे बनाया जाता है; हम केवल एक कीड हैश रखते हैं, इसलिए खोई हुई कुंजी को फिर से नहीं दिखाया जा सकता है। इसके बजाय एक नई कुंजी बनाएं।
सूची पहले अक्षर, अंतिम चार, कुंजी कब बनाई गई और अंतिम बार कब उपयोग की गई, दिखाती है।

डाउनटाइम के बिना कुंजी को रोटेट करने के लिए: दूसरी कुंजी बनाएं, इसे डिप्लॉय करें, कंसोल में इसका अंतिम उपयोग समय जांचें, फिर पुरानी कुंजी को रद्द करें। रद्द की गई कुंजी अगले अनुरोध से 401 unauthorized का उत्तर देती है।

कुंजियों को सुरक्षित रखना

API को अपने सर्वर से कॉल करें, कभी भी ब्राउज़र या मोबाइल ऐप से नहीं: कुंजी वाला कोई भी आपके बैलेंस से संदेश भेज सकता है।
कुंजियों को सोर्स कंट्रोल में नहीं, बल्कि एनवायरनमेंट वेरिएबल्स या सीक्रेट मैनेजर में रखें।
प्रत्येक कुंजी का अपना रेट लिमिट काउंटर होता है, इसलिए एक व्यस्त वर्कर दूसरी कुंजी को धीमा नहीं करता है जो कहीं और उपयोग की जाती है।

एरर्स

401 UnauthorizedJSON

{
  "error": {
    "code": "unauthorized",
    "message": "Send your API key as Authorization: Bearer bsa_live_... Keys are created in the console under API keys.",
    "doc_url": "https://bulksmsapi.cc/en/docs/errors#unauthorized"
  }
}

पिछलाक्विकस्टार्ट अगलासंदेश