Zum Hauptinhalt springen

NGSI

Dieses Dokument enthält einige Beispiele für gängige API-Aufrufe zum Umgang mit Iotnodes über die NGSI-v2-API. Sie können auch über die reguläre Yggio-API mit Iotnodes interagieren. Weitere Informationen zur Yggio-API finden Sie im Abschnitt Umgang mit Iotnodes.

Alle Beispiele, die Zugriffstoken erfordern, werden als „Bearer <token>“ gekennzeichnet, wobei <token> durch Ihr eigenes Zugriffstoken ersetzt werden sollte.

fiware-userid sollte Ihre Nutzer-ID sein, die im Benutzerprofil im Kontrollpanel zu finden ist.

<device_id> ist die 24-stellige Hexadezimalzahl, die zur Identifizierung Ihres Nodes verwendet wird.

Eine neue Entität erstellen​

In diesem Beispiel erstellen wir eine neue Entität vom Typ Room mit einigen Attributen.

curl https://staging.yggio.net/ngsi/v2/entities -s -S -H "Fiware-UserToken: $TKN" -H 'Content-Type: application/json' -d @- <<EOF
{"id":"myRoom","type":"Room","temperature":{"value":23,"type":"Float"},"humidity":{"value":45,"type":"Integer"}}
EOF

Eine Entität aktualisieren​

In diesem Beispiel aktualisieren wir die Beschreibung der Entität.

curl -sS -X POST https://staging.yggio.net/ngsi/v2/entities/<device_id>/attrs?type=Device \
-H 'authorization: Fiware-UserToken <token>' \
-H 'content-type: application/json' \
-H 'fiware-service: yggio' \
-H 'fiware-servicepath: /' \
-H 'fiware-userid: <userid>' \
-d @- <<EOF
{
  "description": "My new description"
}
EOF

Entitäten abrufen​

In diesem Beispiel rufen wir alle Entitäten eines bestimmten Typs ab, in diesem Fall Room.

curl https://staging.yggio.net/ngsi/v2/entities?type=Room -H "Fiware-UserToken: $TKN"

In diesem Beispiel zeigen wir, wie man Entitäten abruft, die einer bestimmten „q query“ entsprechen.

curl "https://ngsi.staging.yggio.net/v2/entities?type=Device&q=<root key>.<key><condition>%27<value>%27" -H "Fiware-UserToken: <token>" -H "fiware-service: yggio" -H "fiware-servicepath: /"

Vollständiges Beispiel:
curl "https://ngsi.staging.yggio.net/v2/entities?type=Device&q=contextMap.Place %3D%3D%%27Building1%27" -H "Fiware-UserToken: <token>" -H "fiware-service: yggio" -H "fiware-servicepath: /"

Ein NGSI-Abonnement erstellen​

curl -sS -X POST https://ngsi.staging.yggio.net/v2/subscriptions -H "Fiware-UserToken: <token>" -H 'Content-Type: application/json' -d @- <<EOF
{
  "description": "Initiate NSGI subscription",
  "subject": {
    "entities": [
      {
        "id": <id>,
        "type": <type>
      }]},
  "notification": {
    "http": {
      "url": <url>
    }}}
EOF

NGSI-Abonnements auflisten​

curl https://ngsi.staging.yggio.net/v2/subscriptions -H "Fiware-UserToken: <token>"