404 लौटाते हैं जब तक लाइव एक्सेस की घोषणा नहीं होती, और सैंडबॉक्स में किसी भी शुल्क का भुगतान नहीं करना होता।
यह क्विकस्टार्ट कॉपी-पेस्ट किए जा सकने वाले अनुरोधों के माध्यम से आपको सैंडबॉक्स एप्लिकेशन से लेकर Didit Test Bank के खातों, शेष राशियों और लेन-देन तक ले जाता है।
नीचे दिया गया हर रिस्पॉन्स केवल उन फ़ील्ड तक सीमित किया गया है जो मायने रखते हैं।
API कुंजी को अपने सर्वर पर ही रखें: यह कभी भी ब्राउज़र या एप्लिकेशन तक नहीं पहुँचती।
चरण 1: Bank data की अनुमति के साथ API कुंजी बनाएँ
Bank data, पूर्ण एक्सेस का हिस्सा नहीं है। पूर्ण एक्सेस वाली कुंजी, जिसमें एप्लिकेशन का प्राथमिक सीक्रेट भी शामिल है, Bank data के हर कॉल पर403 bank_data_access_denied के साथ अस्वीकार की जाती है।
- Business Console में अपना सैंडबॉक्स एप्लिकेशन खोलें और API keys पर जाएँ।
- कस्टम एक्सेस के साथ एक कुंजी बनाएँ और Bank data जोड़ें: पढ़ने वाली कॉल के लिए Read, और कुछ बनाने, बदलने या हटाने वाली कॉल के लिए Write चुनें।
- कुंजी कॉपी करें और उसे एक्सपोर्ट करें:
Step 2: बैंक लिंक बनाएँ
लिंक उन स्क्रीन का एक बार चलने वाला क्रम है जिनमें कोई व्यक्ति अपना बैंक जोड़ता है। Test Bank के लिए एक सतत लिंक बनाएँ:country उस व्यक्ति के बैंक के देश का तीन-अक्षरों वाला कोड है और यह वैकल्पिक है।
जब आपको यह पता हो, तो इसे भेजें, ताकि व्यक्ति को केवल उसी देश के बैंक दिखें; इसके बिना उसे उन सभी देशों के बैंक चुनने होंगे जहाँ आप सेवा दे सकते हैं।
एक बार की पहुँच के लिए "access": "one_time" भेजें (यही डिफ़ॉल्ट है)।
id अपने उपयोगकर्ता के साथ सहेज कर रखें।
url और client_token केवल एक बार लौटाए जाते हैं, जब लिंक बनाया जाता है।
चरण 3: लिंक खोलें और Didit Test Bank से कनेक्ट करें
ब्राउज़र मेंurl खोलें, या इसे ईमेल या चैट से व्यक्ति को भेजें।
व्यक्ति को सहमति स्क्रीन दिखेगी। वह Didit Test Bank चुनेगा, परीक्षण ग्राहकों में से किसी एक से साइन इन करेगा और साझा करने के लिए खाते चुनेगा।
सैंडबॉक्स पेज में परीक्षण ग्राहकों की सूची है और बताया गया है कि हर ग्राहक से आपको क्या मिलता है।
बाद में व्यक्ति को अपनी साइट पर वापस भेजने के लिए अपनी साइट पर वापस लौटें देखें।
redirect_url के बिना व्यक्ति Didit के परिणाम पेज पर ही अपनी प्रक्रिया समाप्त करता है, और आपको परिणाम webhook से या डेटा पढ़ने के अनुरोध से पता चलता है।
चरण 4: webhooks प्राप्त करें और पुष्टि करें
कंसोल मेंbank.* इवेंट्स के लिए एक webhook गंतव्य सब्सक्राइब करें, जैसे किसी भी webhook के लिए करते हैं।
जब व्यक्ति प्रक्रिया पूरी कर लेता है, तो link_id और connection_id के साथ bank.link.completed इवेंट आता है। इसके बाद, जब पहला सिंक खातों को संग्रहीत कर लेता है, तब bank.connection.created आता है।
किसी ब्राउज़र से मिली लिंक ID पर कभी भरोसा न करें।
लिंक की जानकारी स्वयं पढ़ें:
status का मान completed होता है या कोई अंतिम स्थिति (cancelled, expired, failed)। failed लिंक में error.code होता है; cancelled लिंक में error: null दिखता है।
चरण 5: खाते, बैलेंस और लेन-देन पढ़ें
next_page_token तब तक शामिल रहता है जब तक पढ़ने के लिए और डेटा बाकी हो।
देखें खाते, बैलेंस और लेन-देन।
चरण 6: परिवर्तन फ़ीड का अनुसरण करें
परिवर्तन फ़ीड केवल वही लौटाता है जो आपके पिछले रीड के बाद बदला है। आपका पहला रीड, बिना कर्सर के, पूरा स्नैपशॉट होता है: कनेक्शन में मौजूद हर लेन-देन, प्रत्येकadded के रूप में, reset: true के साथ।
पहले पेज में has_more: true, next_page_token हो सकता है और अभी next_cursor न हो।
जब तक has_more true है, page_token के साथ पढ़ना जारी रखें, और अंतिम पेज (जिसमें has_more: false हो) का next_cursor अगली बार के लिए सहेजें:
reset: true का अर्थ है कि रिस्पॉन्स एक पूरा स्नैपशॉट है: उसमें जोड़ने के बजाय अपनी प्रति को उससे बदल दें।
bank.data.updated बताता है कि सिंक ने कुछ नया सहेजा है।
चरण 7: अभी सिंक करें
सतत कनेक्शन अपने आप सिंक होता है। बैंक डेटा अभी पढ़ने के लिए सिंक का अनुरोध करें:sync.live_syncs_left_today और sync.budgets बताते हैं कि कितनी रीडिंग शेष हैं और सीमाएँ कब रीसेट होती हैं, और सीमा से अधिक कॉल 429 refresh_limit_reached लौटाती है, साथ में रीसेट का समय।
देखें: मांग पर बैंक डेटा रीफ़्रेश करें।
चरण 8: पहुँच रोकें और हटाएँ
पहुँच रोकना और हटाना दो अलग-अलग कॉल हैं।id, status, status_reason, created_at और erasure फ़ील्ड होते हैं।
देखें: डेटा, सहमति और हटाना.
अगले चरण
- कनेक्शन: एक बार की और सतत पहुँच, सहमति और नवीनीकरण।
- बैंक webhook
- मूल्य निर्धारण
- API संदर्भ