Upgrade auf Pro

API-Version 1.1

Diese Dokumentation erklärt, wie Du Deine App registrieren, konfigurieren und entwickeln kannst, damit Du unsere APIs erfolgreich nutzen kannst

App erstellen

Damit Deine App auf unsere APIs zugreifen kann, musst Du Deine App über das App-Benutzeroberfläche. Durch die Registrierung wird eine App-ID erstellt, die uns hilft, Deine App von anderen Apps zu unterscheiden.

  1. Du musst eine neue App erstellen Neue App erstellen
  2. Sobald Du Deine App erstellt hast, erhältst du Deine app_id und app_secret
Einloggen mit

Das 'Einloggen mit'-System ist eine schnelle und bequeme Möglichkeit für Personen, Konten zu erstellen und sich bei ihrer App anzumelden.
Unser 'Einloggen mit'-System ermöglicht zwei Szenarien: Authentifizierung und das Anfordern von Berechtigungen für den Zugriff auf die Daten von Personen.
Du kannst das 'Einloggen mit'-System nur für die Authentifizierung oder sowohl für die Authentifizierung als auch für den Datenzugriff verwenden.

  1. Starte den OAuth-Anmeldeprozess. Du musst einen Link für Deine App verwenden, wie folgt:
    <a href="https://www.youprofil.com/api/oauth?app_id=YOUR_APP_ID">Log in With YouProfil</a>

    Der Benutzer wird zur Seite 'Einloggen mit' weitergeleitet, wie folgt

  2. Sobald der Benutzer Deine App akzeptiert hat, wird er zu Deiner App-Redirect-URL weitergeleitet mit auth_key wie folgt:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Dieses auth_key ist nur für die einmalige Verwendung gültig, d. h., wenn Du es einmal benutzt hast, kannst Du es nicht mehr verwenden und musst einen neuen Code generieren, um den Benutzer erneut auf den Link-'Einloggen mit' umzuleiten.
Zugangs-Token

Sobald Du die Benutzerfreigabe für Deine App erhalten hast, logge Dich im 'Einloggen mit'-Fenster ein und kehre zurück mit dem auth_key Das bedeutet, dass Du jetzt bereit bist, Daten von unseren APIs abzurufen und um diesen Prozess zu starten, musst Du Deine App autorisieren und erhältst das access_token und Du kannst unseren Schritten folgen, um zu lernen, wie man es bekommt.

  1. Um ein Zugriffstoken abzurufen, stelle eine HTTP-GET-Anfrage an den folgenden Endpunkt, wie folgt:
    <?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://www.youprofil.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
    }
    ?>
    Dieses access_token ist nur für 1 Stunde gültig, d.h. wenn es ungültig geworden ist, musst Du ein neues generieren, indem Du den Benutzer wieder auf den 'Einloggen mit'-Link umleitest.
APIs

Sobald Du Dein access_token erhalten hast, kannst Du nun Infos aus unserem System über HTTP GET-Anfragen abrufen, die folgende Parameter unterstützen

Endpunkt Beschreibung
api/get_user_info

Benutzerinfos abrufen

Du kannst die Benutzerinfos wie folgt abrufen

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

Das Ergebnis lautet:

{
    "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": ""
    }
}