מפתחים | Free IL

גרסת API 1.1

תיעוד זה מסביר כיצד לרשום, להגדיר ולפתח את האפליקציה שלכם כדי שתוכלו להשתמש בהצלחה בממשקי ה-API שלנו

יצירת אפליקציה

כדי שהאפליקציה שלכם תוכלו לגשת לממשקי ה-API שלנו, עליכם לרשום את האפליקציה שלכם באמצעות לוח הבקרה של האפליקציה. הרישום יוצר מזהה אפליקציה שמאפשר לנו לדעת מי אתם, עוזר לנו להבחין בין האפליקציה שלכם לאפליקציות אחרות.

יהיה עליכם לייצור אפליקציה חדשה יצירת אפליקציה חדשה
לאחר שייצרתם את האפליקציה שלכם תקבלו את app_id ו app_secret

התחברו עם

התחברות עם הרשת שלנו היא דרך מהירה ונוחה לאנשים ליצירת חשבונות וכניסה לאפליקציה שלכם. מערכת התחברות עם הרשת שלנו מאפשרת שני תרחישים, אימות ובקשת הרשאות לגשת לנתונים של אנשים. אתם יכולים להשתמש בהתחברות עם מערכת פשוטה לאימות או גם לאימות וגם לגישה לנתונים.

התחלת תהליך ההתחברות של OAuth, עליכם להשתמש בקישור לאפליקציה שלכם כמו זה:
```
<a href="https://freeil.org/api/oauth?app_id=YOUR_APP_ID">Log in With Free IL</a>
```
המשתמש יופנה לדף כניסה עם כך
לאחר שהמשתמש יאשר את האפליקציה שלכם, המשתמש יופנה אל כתובת האתר להפניה מחדש של האפליקציה שלכם auth_key ככה:
```
https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
```
זה auth_key תקף לשימוש חד פעמי בלבד, כך שברגע שהשתמשתם בו לא תוכלו להשתמש בו שוב וביצירת קוד חדש תצטרכו להפנות את המשתמשים לכניסה עם קישור חדש.

טוקן גישה

ברגע שתקבלו את אישור שהמשתמש של האפליקציה שלכם התחברו עם חלון נפרד, יחזור למסך עם ה auth_key מה שאומר שעכשיו אתם מוכנים למשוך נתונים מממשקי ה-API שלנו וכדי להתחיל בתהליך זה תצטרכו לאשר את האפליקציה שלכם ולקבל את access_token ואתם יכולים לעקוב אחר השלבים שלנו כדי ללמוד איך לעשות את זה.

כדי לקבל טוקן גישה, בצעו בקשת 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://freeil.org/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 תקף רק לשעה אחת בלבד, אז ברגע שהוא פג תוקף תצטרכו ליצור אחד חדש על ידי הפניית המשתמש לכניסה עם קישור חדש.

ממשקי API

ברגע שתקבלו את 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://freeil.org/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": ""
              }
            }