Dokumentation

Dokumentation der API

Die API befindet sich derzeit noch in der Entwicklung. Aufgrund dessen kann es jederzeit zu Anpassungen an der Schnittstelle kommen.

REST API

Hier finden Sie den öffentlichen Teil der API für die Nutzung als Lizenznehmer. Um diese API nutzen zu können, brauchen Sie eine gültige Lizenz welche Sie über unsere Verkaufsseiten erwerben können. Sofern Sie spezielle Fragen oder Wünsche zu der API haben, schreiben Sie uns einfach eine Nachricht über unser Kontaktformular. So können wir Ihre Anfragen am besten verwalten.

Die Auswertungen sind in verschiedenen Sprachen verfügbar.

Derzeit befinden sich noch weitere Module in der Programmierung.

Unsere Verkaufsseiten:

Personality Check Persönlichkeit: Jetzt Lizenz erwerben

Hier können Sie die Produkte regulär erwerben:

Personality Check Persönlichkeit: Hier erwerben

Licence-Check

/licence/?licence_key=XXX

Es wird geprüft ob die erworbene Lizenz aktiv ist. Es wird ein Resultat in Form eines JSON-Objekts geliefert.

Beispiel-Ausgabe:

{
"code": 200,
"lizenz_email": "test@example.org",
"lizenz_key": "xxx-xxx-xxx-xxx",
"lizenz_status": "active",
"lizenz_credits": "9982",
"lizenzart": "Prepaid",
"lizenz_auswertungen": "69"
}

 

Auswertung für das Tool Personality Check Persönlichkeit

/liebe/bday/?licence_key=xxx-xxx-xxx-xxx&bday=xx.xx.xxxx

Für die Nutzung unserer Lizenznehmer müssen gewisse Aspekte des Datenschutzes beachtet werden. Die personenbezogenen Daten bleiben auf der Seite des Clients. Dort wird ein Hash erzeugt, welcher an die API ermittelt wird und die Auswertung in Form eines JSON-Objekts zurückgibt.

Beispielausgabe:
Um die Ausgabe einigermaßen lesen zu können, wurde diese in GitHub hochgeladen.

JETZT ANSEHEN

Auswertung für das Tool Personality Check Soft Skills

/softskills/bday/?bday=01.01.1990&licence_key=XXX

Für die Nutzung unserer Lizenznehmer müssen gewisse Aspekte des Datenschutzes beachtet werden. Die personenbezogenen Daten bleiben auf der Seite des Clients. Dort wird ein Hash erzeugt, welcher an die API ermittelt wird und die Auswertung in Form eines JSON-Objekts zurückgibt.

Beispielausgabe:
Um die Ausgabe einigermaßen lesen zu können, wurde diese in GitHub hochgeladen.

JETZT ANSEHEN

Auswertung für das Tool Entscheidungen

/entscheidungen?stichtag=17.07.2015&bday=17.11.1975;08.08.1975;07.08.1975&licence_key=xxx-xxx-xxx-xxx

Mit der Übergabe des Stichtages und den Geburtstagen wird die passende Auswertung erstellt und im JSON-Format zur Weiterverarbeitung ausgegeben. 
Die Geburtstage der einzelnen Personen werden mit einem Komma getrennt.

Beispielausgabe:
Um die Ausgabe einigermaßen lesen zu können, wurde diese in GitHub hochgeladen.

JETZT ANSEHEN

Userdaten auslesen

/user/data?email=test@example.org&licence_key=xxx-xxx-xxx-xxx

Mit dem Lizenzschlüssel als Übergabeparameter kann man die Nutzerdaten des des Lizenznehmers sowie diverse andere Daten auslesen.

Beispielausgabe:

{
"code": 200,
"vorname": "Max",
"nachname": "Mustermann",
"email": "max.mustermann@example.org",
"street": "Musterstr. 123",
"plz": "12345",
"city": "Musterstadt",
"bday": 01.01.2000
}

Aktualisierung der Nutzerdaten

/user/update/?licence_key&...

Diese Schnittstelle ermöglicht es den Usern der App, Daten ihres Profils zu verwalten bzw. auf dem aktuellsten Stand zu halten.

Als Übergabeparameter dienen der Vorname, Nachname, Straße, Wohnort, PLZ und Geburtsdatum

Beispielausgabe:

{
"code": 200,
"message": "success"
}

Beispielabfrage PHP

Um unsere API zu kontaktieren, benötigt es nur einen einfach Aufruf der PHP-Funktion file_get_contents($url) mit der API-URL als Parameter.

Beispiel:

$result = file_get_contents(
"/api/v1/liebe/bday?bday=01.01.2000&licence_key=xxx-xxx-xxx-xxx");

Wie man APIs verwendet

Download Postbote: https://www.getpostman.com/downloads/

Postman ist ein API (Application Programming Interface) Entwicklungswerkzeug, das beim Erstellen, Testen und Modifizieren von APIs hilft.

Wir erstellen eine neue POST-Anfrage: https://api.personalitycheck-online.com/wp-json/jwt-auth/v1/token

und auf der Registerkarte Körper geben wir die Parameter ein:

username:

Passwort:

Hinweis: Benutzername und Passwort sind Zugangsdaten für den Benutzer von: https://api.personalitycheck-online.com

Nachdem wir auf die Schaltfläche Senden geklickt haben, werden Token generiert, basierend auf den von uns eingegebenen Anmeldeinformationen.

Wir verwenden dieses Token als Schlüssel für Zugriffs-APIs. Wir erstellen eine neue GET-Anfrage und wählen auf der Registerkarte Autorisierung TYP: Inhaber-Token und geben Sie den Token ein:

In dieser GET-Anfrage können wir die API des Erweiterungs-Toolkits verwenden und die URLs der APIs testen:

Erweiterungs-API

erforderliche Parameter: bday, stichtag, licence_key ODER email

optionale Parameter: vname, nname, nname

https://api.personalitycheck-online.com/wp-json/api/v1/extension/?stichtag=10.5.2009&bday=23.06.1985&email=apalazov@yahoo.com

https://api.personalitycheck-online.com/wp-json/api/v1/extension/?stichtag=10.5.2009&bday=23.6.1985&licence_key=12345

Ergebnis nach dem Absenden der API-Anfrage mit korrektem Token:

Ergebnis nach dem Senden einer API-Anfrage mit falschem Token:

Ergebnis nach dem Senden einer API-Anfrage mit leerem Token: