Skip to content

API Funktionen: Zugriff auf API Keys

mjaschen edited this page Feb 1, 2012 · 1 revision

Es ist möglich per API-Funktionsaufruf den/die API-Keys abzurufen.

Dazu wird ein normaler POST-Login-Request benutzt, bei dem Benutzername und Kennwort oder E-Mail-Adresse und Kennwort mitgeschickt werden.

Bei diesem Request muss der API-Key (logischerweise) nicht mitgeschickt werden. Ein mitgeschickter API-Key hat keine Auswirkung und authentifiziert den Client nicht (es wird eine Fehlermeldung zurückgegeben).

Sollte für den authentifizierten User noch kein API-Key existieren, wird automatisch einer erstellt und zurückgegegeben.

Beispiele

curl-Command-Line-Tool:

curl --data 'login=foobar' --data 'password=supersecret' \
https://gewichte.mtb-news.de/api/v1/tokens/get.json

oder

curl --data '[email protected]' --data 'password=supersecret' \
https://gewichte.mtb-news.de/api/v1/tokens/get.json

URL

/api/v1/tokens/get.json

POST-Daten

  • login: Benutzername oder E-Mail-Adresse
  • password: Kennwort

Die Daten werden als application/x-www-form-urlencoded gesendet.

Beispielausgabe

{
    "status": "OK",
    "messages": [],
    "data": {
        "tokens": [{
            "token": "XXXXX5OWASZOH7U334P1ZK9LNMTHZEFYYYYY",
            "description": ""
        },
        {
            "token": "XXXXXLGVMP6MS8QWM5TQUTY9Y7MHBSOYYYYY",
            "description": ""
        }]
    }
}