प्रलेखन

एपीआई संस्करण 1.1

यह दस्तावेज़ बताता है कि अपने ऐप को कैसे पंजीकृत, कॉन्फ़िगर और विकसित करें ताकि आप हमारे एपीआई का सफलतापूर्वक उपयोग कर सकें

एप्लिकेशन बनाएँ

अपने ऐप को हमारे एपीआई तक पहुंचने के लिए, आपको अपने ऐप का उपयोग करके पंजीकृत करना होगा ऐप डैशबोर्ड. पंजीकरण एक ऐप आईडी बनाता है जो हमें बताता है कि आप कौन हैं, हमें अपने ऐप को अन्य ऐप्स से अलग करने में मदद करता है.

  1. आपको एक नया ऐप बनाने की आवश्यकता होगी नया अनुप्रयोग बनाएँ
  2. एक बार जब आप अपना ऐप बना लेते हैं तो आपको अपना ऐप मिल जाएगा app_id और app_secret
के साथ लॉग इन करें

सिस्टम के साथ लॉग इन करना लोगों के लिए खाते बनाने और आपके ऐप में लॉग इन करने का एक तेज़ और सुविधाजनक तरीका है। हमारा लॉग इन विद सिस्टम दो परिदृश्यों को सक्षम करता है, प्रमाणीकरण और लोगों के डेटा तक पहुंचने के लिए अनुमतियाँ मांगना। आप केवल प्रमाणीकरण के लिए या प्रमाणीकरण और डेटा एक्सेस दोनों के लिए लॉगिन विद सिस्टम का उपयोग कर सकते हैं.

  1. OAuth लॉगिन प्रक्रिया शुरू करते हुए, आपको इस तरह अपने ऐप के लिए एक लिंक का उपयोग करने की आवश्यकता है:
    <a href="https://ifvex.com/api/oauth?app_id=YOUR_APP_ID">Log in With Ifvex</a>

    उपयोगकर्ता को इस तरह के पृष्ठ के साथ लॉग इन करने के लिए रीडायरेक्ट किया जाएगा

  2. एक बार जब उपयोगकर्ता आपके ऐप को स्वीकार कर लेता है, तो उपयोगकर्ता को आपके ऐप रीडायरेक्ट यूआरएल पर रीडायरेक्ट किया जाएगा auth_key इस तरह:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    यहन auth_key केवल एक बार उपयोग के लिए मान्य है, इसलिए एक बार जब आप इसका उपयोग करते हैं तो आप इसे फिर से उपयोग नहीं कर पाएंगे और नया कोड उत्पन्न करेंगे, आपको उपयोगकर्ता को फिर से लिंक के साथ लॉग इन पर रीडायरेक्ट करना होगा.
Access Token

एक बार जब आप अपने ऐप्लिकेशन की उपयोगकर्ता स्वीकृति प्राप्त कर लेते हैं, तो विंडो के साथ लॉग इन करें और इसके साथ लौट आएं auth_key जिसका मतलब है कि अब आप हमारे एपीआई से डेटा को पुनः प्राप्त करने के लिए तैयार हैं और इस प्रक्रिया को शुरू करने के लिए आपको अपने ऐप को अधिकृत करना होगा और प्राप्त करना होगा। access_token और आप इसे प्राप्त करने का तरीका जानने के लिए हमारे चरणों का पालन कर सकते हैं.

  1. एक्सेस टोकन प्राप्त करने के लिए, निम्नलिखित समापन बिंदु पर इस तरह एक HTTP GET अनुरोध करें:
                <?php
                $app_id = "YOUR_APP_ID"; // your app id
                $app_secret = "YOUR_APP_SECRET"; // your app secret
                $auth_key = $_GET['auth_key']; // the returned auth key from previous step
    
                $get = file_get_contents("https://ifvex.com/api/authorize?app_id=$app_id&app_secret=$app_secret&auth_key=$auth_key");
    
                $json = json_decode($get, true);
                if(!empty($json['access_token'])) {
                    $access_token = $json['access_token']; // your access token
                }
                ?>                                                                                                
                                
    यहन access_token केवल एक 1 घंटे के लिए मान्य है, इसलिए एक बार जब यह अमान्य हो जाता है तो आपको उपयोगकर्ता को फिर से लिंक के साथ लॉग इन पर रीडायरेक्ट करके नए को जेनार्ट करने की आवश्यकता होगी.
एपीआई

एक बार जब आप अपना प्राप्त करते हैं access_token अब आप HTTP GET अनुरोधों के माध्यम से हमारे सिस्टम से जानकारी प्राप्त कर सकते हैं जो निम्नलिखित मापदंडों का समर्थन करता है

समापन बिंदु विवरण
api/get_user_info

उपयोगकर्ता जानकारी प्राप्त करें

आप इस तरह उपयोगकर्ता जानकारी को पुनः प्राप्त कर सकते हैं

            if(!empty($json['access_token'])) {
                $access_token = $json['access_token']; // your access token
                $get = file_get_contents("https://ifvex.com/api/get_user_info?access_token=$access_token");
            }
                        

परिणाम होगा:

            {
              "user_info": {
              "user_id": "",
              "user_name": "",
              "user_email": "",
              "user_firstname": "",
              "user_lastname": "",
              "user_gender": "",
              "user_birthdate": "",
              "user_picture": "",
              "user_cover": "",
              "user_registered": "",
              "user_verified": "",
              "user_relationship": "",
              "user_biography": "",
              "user_website": ""
              }
            }