Ihre erste API-Anfrage

Von Ihrem IRIS Cloud-Konto zur ersten Maschinenabfrage in wenigen Schritten.

Bevor Sie beginnen#

Ein IRIS Cloud-Konto mit Zugriff auf Ihre Organisation.
Ein unter User Account → IRIS Cloud API Tokens erstelltes API-Token. Folgen Sie der Token-Anleitung.
Ein Terminal mit cURL oder die interaktive API-Referenz.

Erste Anfrage senden#

Stellen Sie Ihr Token über die Umgebungsvariable CONNECT_API_TOKEN bereit. In Bash verhindert die folgende Eingabeaufforderung, dass das Token im Befehlsverlauf gespeichert wird:

read -r -s -p 'Connect API token: ' CONNECT_API_TOKEN
printf '\n'
export CONNECT_API_TOKEN

Fragen Sie die verfügbaren Maschinen Ihrer Organisation ab:

curl --request GET \
  --url 'https://connect-api.iris-cloud.netzsch.com/api/v1/machines' \
  --header "Authorization: Bearer $CONNECT_API_TOKEN" \
  --header 'Accept: application/json'

Das Token wird im Header Authorization gesendet. Fügen Sie es nicht in die URL ein.

Antwort lesen#

Eine erfolgreiche Anfrage liefert 200 OK und JSON zurück. Diese verkürzte Beispielantwort zeigt das Array data:

{
  "data": [
    {
      "id": "machine-example",
      "name": "Production mill",
      "status": "IDLE"
    }
  ]
}

Verwenden Sie die id einer Maschine in nachfolgenden Anfragen. Ein leeres Array data bedeutet, dass diese Anfrage keine sichtbaren Maschinen geliefert hat; es ist kein Authentifizierungsfehler. Das vollständige Antwortschema finden Sie in der Referenz.

Sensoren ermitteln#

Ersetzen Sie MACHINE_ID durch eine ID aus Ihrer Maschinenabfrage.

curl 'https://connect-api.iris-cloud.netzsch.com/api/v1/machines/MACHINE_ID/sensors' \
  --header "Authorization: Bearer $CONNECT_API_TOKEN"

Rufen Sie anschließend eine Momentaufnahme oder historische Messwerte ab. Falls die erste Anfrage fehlschlägt, hilft die Anleitung zur Fehlerbehebung.

WEITERLESENAPI-Token erstellen