גרסת API 1.1
מדריך זה מסביר כיצד לרשום, להגדיר ולפתח את האפליקציה שלך לשימוש מוצלח ב-API שלנו
צור אפליקציה
כדי שהאפליקציה שלך תוכל לגשת ל-API שלנו, עליך לרשום אותה באמצעות לוח הבקרה של האפליקציה. ההרשמה יוצרת מזהה אפליקציה שמזהה אותך ועוזר לנו להבחין בין האפליקציה שלך לאחרות.
- יהיה עליך ליצור אפליקציה חדשה צור אפליקציה חדשה
- לאחר שתיצור את האפליקציה שלך תקבל את app_id ו־ app_secret
התחבר עם
מערכת ההתחברות שלנו מאפשרת לאנשים ליצור חשבון ולהתחבר במהירות. היא תומכת באימות זהות בלבד או באימות יחד עם בקשת גישה לנתוני המשתמש.
-
כדי להתחיל את תהליך התחברות OAuth, השתמש בקישור כזה לאפליקציה שלך:
<a href="https://social.server-hssd.com/api/oauth?app_id=YOUR_APP_ID">Log in With LikViu</a>
המשתמש יופנה לדף ההתחברות שנראה כך
-
לאחר שהמשתמש יאשר את האפליקציה שלך, הוא יופנה ל-Redirect URL שלך עם auth_key כמו זה:
https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
זה auth_key תקף לשימוש חד פעמי בלבד. לאחר השימוש, לא ניתן להשתמש בו שוב — עליך להפנות את המשתמש שוב לקישור התחברות.
אסימון גישה
לאחר שהמשתמש יאשר את חלון ההתחברות של האפליקציה שלך ויחזור עם auth_key מה שאומר שאתה מוכן כעת לאחזר נתונים מ־API שלנו. כדי להתחיל, עליך לאשר את האפליקציה ולקבל את access_token אתה יכול לעקוב אחר ההוראות שלנו כדי ללמוד איך להשיג אותו.
-
כדי לקבל 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 // Prepare the POST data $postData = [ 'app_id' => $app_id, 'app_secret' => $app_secret, 'auth_key' => $auth_key ]; // Initialize cURL $ch = curl_init('https://social.server-hssd.com/api/authorize'); // Set cURL options for POST curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData)); // Execute request $response = curl_exec($ch); // Check for cURL errors if (curl_errno($ch)) { die('cURL error: ' . curl_error($ch)); } curl_close($ch); // Decode the JSON response $json = json_decode($response, true); // Use the access token if available if (!empty($json['access_token'])) { $access_token = $json['access_token']; // your access token } ?>זה access_token תקף לשעה אחת בלבד. כשתפוג תוקפו, יהיה עליך להפיק חדש ע״י הפניית המשתמש שוב לקישור ההתחברות.
ממשקי API
לאחר שקיבלת את access_token כעת תוכל לשלוף מידע מהמערכת שלנו באמצעות בקשות HTTP GET שתומכות בפרמטרים הבאים
| נקודת קצה (Endpoint) | תיאור |
|---|---|
| api/get_user_info |
קבלת פרטי משתמש |
ניתן לשלוף פרטי משתמש כך
if(!empty($json['access_token'])) {
$access_token = $json['access_token']; // your access token
$get = file_get_contents("https://social.server-hssd.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": ""
}
}