वेब टॉप-अप एपीआई

इंटिग्रेटर को एक वेब होस्ट लागू करना होगा, ताकि उपयोगकर्ताओं को टॉप-अप के लिए रीडायरेक्ट किया जा सके. इस टॉप-अप का इस्तेमाल अलग तरह से किया जाता है. हालांकि, इसका मकसद Android टॉप-अप से मिलने वाले टॉप-अप के तरीके जैसा ही है. इस वेब होस्ट की एक मोबाइल-फ़्रेंडली वेबसाइट होनी चाहिए.

वेब होस्ट को उपयोगकर्ता-एजेंट के हेडर की वैल्यू के आधार पर, मोबाइल वेब के अनुरोध और डेस्कटॉप वेब के अनुरोध तय करने चाहिए. मोबाइल वेब अनुरोधों पर डिलीवर किया गया पेज, Android और iOS पर मोबाइल वेब-फ़्रेंडली होना चाहिए. उपयोगकर्ता-एजेंट हेडर वैल्यू के अलावा, क्लाइंट आपको उस एनवायरमेंट के बारे में कोई और संकेत नहीं देगा जहां यह उपयोगकर्ता अनुरोध कर रहा है (डेस्कटॉप या वेब).

सर्वर को GET का इस्तेमाल करके एचटीटीपीएस प्रोटोकॉल लागू करना होगा. पाथ और होस्ट को इंटिग्रेटर तय करता है. इंटिग्रेटर के यूआरएल में 2,048 वर्ण होने चाहिए. इसमें स्कीम, होस्ट, पोर्ट, पाथ, और पैरामीटर शामिल हैं.

यूआरएल-कोड में बदलने से पहले, सभी पैरामीटर UTF-8 में एन्कोड किए जाएंगे.

अनुरोध

अनुरोध किए जाने पर, Google इन्हें यूआरएल पैरामीटर के तौर पर उपलब्ध कराता है:

फ़ील्ड
gspMajorVersion	int इस अनुरोध का मेजर वर्शन नंबर.
gspTopUpRequest	TopUpRedirectRequest टॉप-अप का अनुरोध.
gspAssociationId	string इसमें एक ऐसा आइडेंटिफ़ायर होता है जिसका इस्तेमाल करके इंटिग्रेटर, उस खाते के क्रेडेंशियल खोजता है जिसे उपयोगकर्ता टॉप अप कर रहा है. यह असोसिएशन आईडी है, जो AssociatedAccountRequest में खाता लिंक करने के दौरान भेजा जाता है.
gspCallbackUrl	string वह यूआरएल जिस पर लोगों को Google पर टॉप-अप फ़्लो पूरा करने के लिए, रीडायरेक्ट किया जाता है. यह मान यूआरएल कोड में बदला गया है.

जवाब

टॉप-अप पूरा होने के बाद, उपयोगकर्ता को एचटीटीपीएस जीईटी का इस्तेमाल करके gspCallbackUrl पर रीडायरेक्ट किया जाना चाहिए. इस यूआरएल में नीचे दिए गए क्वेरी पैरामीटर होने चाहिए:

फ़ील्ड
gspResult	int 100 टॉप-अप की प्रोसेस पूरी हुई. 201 उपयोगकर्ता ने फ़्लो को मैन्युअल तरीके से रद्द कर दिया है और अब फ़्लो को रद्द कर दिया जाएगा. 202 किसी गंभीर वजह से टॉप-अप नहीं हो सका. इसलिए, फ़्लो को रद्द कर दिया जाना चाहिए.
redirectRequestId	string ज़रूरी: मूल/शुरू किए जा रहे रीडायरेक्ट पेमेंट के अनुरोध में भेजा गया requestId. Google पुष्टि करेगा कि यह भेजे गए requestId से मेल खाता है या नहीं. अगर यह मेल नहीं खाता है, तो पूरा रीडायरेक्ट फ़्लो काम नहीं करेगा.
gspTopUpResponse	RedirectResponse ज़रूरी है: TopUpRedirectResponse को PGP या JWE+JWS का इस्तेमाल करके एन्क्रिप्ट (सुरक्षित) किया जाना चाहिए और उस पर हस्ताक्षर किया जाना चाहिए. इसके अलावा, यह वैल्यू base64 कोड में बदली गई वेब के साथ सुरक्षित होनी चाहिए.