Zum Inhalt springen
aYOUne
← iot API

ScannerDevices

Singular: ScannerDevice — Base-URL: https://scan.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "_id": "6ac08a34b293ef49f1dc89db",
    "active": true,
    "name": "TEMPORARY_OLIVE_RATTS TYEREL",
    "paired": false,
    "scanCount": 0,
    "status": "ok",
    "createdBy": "6045f4d25704710012485569",
    "shares": [],
    "createdAt": "2026-10-03T04:53:08.872Z",
    "updatedAt": "2026-10-03T04:53:08.872Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://scan.ayoune.app/scannerdevices/6ac08a34b293ef49f1dc89db",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6ac08a35b293ef49f1dc8a0f",
    "errors": [],
    "actions": [],
    "version": {
      "host": "2026.7.0",
      "core": "2026.350.1"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9995",
      "reset": "1791006789",
      "resetDate": "Sat Oct 03 2026"
    },
    "responseTime": 1787.23259,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /scannerdevices Liste mit Filtern/Paginierung iot.scannerdevices.view
GET /scannerdevices/:id Einzelner Datensatz iot.scannerdevices.view
POST /scannerdevices Neuen Datensatz erstellen iot.scannerdevices.new
PUT /scannerdevices Datensatz aktualisieren iot.scannerdevices.edit
DELETE /scannerdevices/:id Datensatz löschen iot.scannerdevices.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// Alle abrufen
const list = await ay.iot.scannerDevices.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.iot.scannerDevices.findById('OBJECT_ID').exec();

// Erstellen
const created = await ay.iot.scannerDevices.create({ name: 'Foo' });

Weiterführend