Documentatie

API Versie 1.1

In deze documentatie wordt uitgelegd hoe u uw app registreert, configureert en ontwikkelt, zodat u onze API's succesvol kunt gebruiken

App maken

Om uw app toegang te geven tot onze API's, moet u uw app registreren met behulp van de App Dashboard. Registratie creëert een App-ID die ons laat weten wie u bent, helpt ons uw app te onderscheiden van andere apps.

  1. U moet een nieuwe app maken Maak Nieuwe App
  2. Zodra u uw app hebt gemaakt, ontvangt u uw app_id en app_secret
Login Met

Het Log in With-systeem is een snelle en handige manier voor mensen om accounts aan te maken en in te loggen op uw app. Ons Log in With-systeem maakt twee scenario's mogelijk: authenticatie en het vragen om toestemming om toegang te krijgen tot de gegevens van mensen. U kunt het Login With-systeem gebruiken voor authenticatie of voor zowel authenticatie als toegang tot gegevens.

  1. Om het OAuth-inlogproces te starten, moet u een link voor uw app gebruiken zoals deze:
    <a href="https://friendhyve.com/api/oauth?app_id=YOUR_APP_ID">Log in With FriendHyve</a>

    De gebruiker wordt doorgestuurd naar de pagina Inloggen met zoals deze

  2. Zodra de gebruiker uw app heeft geaccepteerd, wordt de gebruiker doorgestuurd naar uw App Redirect URL met auth_key zoals dit:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Dit auth_key slechts geldig voor eenmalig gebruik, dus als u het eenmaal heeft gebruikt, kunt u het niet meer gebruiken en nieuwe code genereren. U moet de gebruiker opnieuw doorverwijzen naar de login met link.
Toegangstoken

Zodra u de goedkeuring van de gebruiker voor uw app hebt gekregen, logt u in met het venster en keert u terug met de auth_key wat betekent dat u nu klaar bent om gegevens op te halen uit onze API's en om dit proces te starten, moet u uw app autoriseren en de access_token en u kunt onze stappen volgen om te leren hoe u het kunt krijgen.

  1. Om een ​​toegangstoken te verkrijgen, dient u een HTTP GET-verzoek in bij het volgende eindpunt, zoals dit:
    <?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://friendhyve.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
    }
    ?>
    
    Dit access_token alleen geldig voor slechts 1 uur, dus zodra deze ongeldig is, moet u een nieuwe genereren door de gebruiker opnieuw door te verwijzen naar de inlogpagina met de link.
APIs

Zodra je je access_token U kunt nu informatie uit ons systeem ophalen via HTTP GET-verzoeken die de volgende parameters ondersteunen

Endpoint Beschrijving
api/get_user_info

gebruikersinfo ophalen

U kunt gebruikersinfo op deze manier ophalen

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

Het resultaat zal zijn:

{
  "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": ""
  }
}
FriendHyve https://friendhyve.com