1. Die API
  2. Info-Module
  3. system
  4. alive

system.alive Ist die API bereit und antwortet korrekt?

Grundlagen

Die alive-action bringt die API dazu, ihren Status zu überprüfen und zurückzugeben. Auch die aktuelle API-Version wird Ihnen hier geliefert.

API-Anfrage

Um die alive-action auszuführen, müssen Sie beim API-Aufruf das Modul system und die Aktion alive übergeben::

Übergeben Sie ein JSON-Objekt als String via POST oder GET aus Ihrer Software:

{
   "action" : "alive",
   "apikey" : "abcd1234",
   "modul" : "system"
}

Nutzen Sie die Punktnotation, um die Daten per POST oder GET an die API zu übertragen:

action=alive
apikey=abcd1234
modul=system

https://nettz.de/api.cgi?action=alive&apikey=abcd1234&modul=system

Übertragen Sie die Parameter per XML an die API:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<opt action="alive" apikey="abcd1234" modul="system" />

Es sind keine zusätzlichen Parameter möglich. Ersetzen Sie vor dem Aufruf den API-Key abcd1234 durch einen Ihrer persönlichen API-Keys.

API-Antwort

Wenn die API funktionstüchtig ist, erhalten Sie folgende Antwort von ihr:

{
   "data" : {
      "version_api" : "1.0"
   },
   "status" : 1,
   "timestamp" : 1560359991
}

data.version_api=1.0
status=1
timestamp=1560359991

data.version_api=1.0&status=1&timestamp=1560359991
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<opt status="1"
     timestamp="1560359991">
  <data version_api="1.0" />
</opt>

Sollte die API nicht verfügbar sein, wird Ihre Anfrage mit einer Fehlermeldung quittiert:

{
   "errid" : 100,
   "errmsg" : "API is 15 mins down for maintance (till 12:00)",
   "status" : -1
}

errid=100
errmsg=API is 15 mins down for maintance (till 12:00)
status=-1

errid=100&errmsg=API%20is%2015%20mins%20down%20for%20maintance%20(till%2012:00)&status=-1
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<opt errid="100"
     errmsg="API is 15 mins down for maintance (till 12:00)"
     status="-1" />

Erklärung der data-Informationen

Folgende Informationen können im data-Zweig enthalten sein::

  • version_api - Die aktuelle Version der API

Beispiel-Aufrufe und -Antworten

Es sind noch keine Beispiele hinterlegt

Quellen / Anbieter

Bei Nutzung dieser action werden nur interne Daten/Algorithmen genutzt.

Aktueller Status

  • Level:
    Info-Module mit dem Status @lpha sind neu und noch nicht ausgiebig getestet. Produktive Anbindungen dieser action werden _nicht_ empfohlen! Feedback, Bugmeldungen und Verbesserungsvorschläge sind dagegen herzlich willkommen!
  • Credits pro Aufruf:
    0.001
  • Letzte Änderung:
    Noch keine Änderung