Dokumentation

API-Version 1.1

Diese Dokumentation erklärt, wie Sie Ihre Anwendung registrieren, konfigurieren und entwickeln, damit Sie unsere APIs erfolgreich nutzen können

App erstellen

Damit Ihre Anwendung auf unsere APIs zugreifen kann, müssen Sie Ihre Anwendung über das App-Dashboard registrieren. Die Registrierung erstellt eine App-ID, die uns wissen lässt, wer Sie sind und uns hilft, Ihre App von anderen Apps zu unterscheiden.

  1. Sie müssen eine neue App erstellen Neue App erstellen
  2. Wenn Sie Ihre App erstellt haben, erhalten Sie Ihre app_id und app_secret
Einloggen mit

Einloggen mit dem System ist eine schnelle und bequeme Möglichkeit für Personen, Konten zu erstellen und sich bei Ihrer Anwendung anzumelden. Unser System Einloggen mit ermöglicht zwei Szenarien, nämlich die Authentifizierung und die Abfrage von Berechtigungen für den Zugriff auf die Daten von Personen. Sie können Einloggen mit System einfach zur Authentifizierung oder für den Datenzugriff verwenden.

  1. Wenn Sie den OAuth-Anmeldeprozess starten, müssen Sie einen Link für Ihre App verwenden:
    <a href="https://www.neckmax.de/api/oauth?app_id=YOUR_APP_ID">Log in With Neckmax.de</a>

    Der Benutzer wird zu der Seite "Einloggen mit" weitergeleitet

  2. Sobald der Benutzer Ihre App akzeptiert hat, wird der Benutzer mit auth_key wie folgt auf Ihre App-Weiterleitungs-URL weitergeleitet:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Dieser auth_key ist nur für einen einmaligen Zugriff gültig, so dass Sie ihn nach seiner einmaligen Verwendung nicht mehr verwenden und keinen neuen Code generieren können, sondern den Benutzer erneut zum Einloggen mit weiterleiten müssen.
Zugangsschlüssel

Sobald Sie die Benutzergenehmigung für Ihre App erhalten haben, melden Sie sich im Fenster "Einloggen mit" an und kehren Sie mit dem auth_key zurück. Dies bedeutet, dass Sie jetzt bereit sind, Daten von unseren APIs abzurufen und diesen Prozess zu starten. Sie müssen Ihre App autorisieren und den access_token erhalten, und Sie können unseren Schritten folgen, um zu erfahren, wie Sie ihn erhalten.

  1. Um ein Zugangsschlüssel zu erhalten, stellen Sie 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.neckmax.de/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
                }
                ?>                                                                                                
                                
    Dieser access_token ist nur für eine Stunde gültig, so dass Sie, sobald er ungültig geworden ist, einen neuen generieren müssen, indem Sie den Benutzer wieder zum Einloggen mit weiterleiten.
Schnittstellen

Sobald Sie Ihren access_token erhalten haben, können Sie nun Informationen aus unserem System über HTTP-GET-Anfragen abrufen, die folgende Parameter unterstützen

Endpunkt Beschreibung
api/get_user_info

Benutzerinformationen abrufen

Sie können Benutzerinformationen wie folgt abrufen

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

Das Ergebnis wird sein:

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