aYOUne
← Konfiguration API

WebReceivers

Singular: WebReceiver — Base-URL: https://config-api.ayoune.app — Zugriff: CRUD

play_circle 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": {
    "numInvocations": 0,
    "_id": "65e0b086121b7d48fe15827d",
    "mandatoryFields": [],
    "createdBy": "6045f4d25704710012485569",
    "headers": [],
    "queryParams": [],
    "createdAt": "2024-02-29T16:27:50.484Z",
    "updatedAt": "2024-02-29T16:27:50.484Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/webreceivers/65e0b086121b7d48fe15827d",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Middlewares",
        "title": "MODEL_MIDDLEWARE",
        "href": "https://api.ayoune.app/config/middlewares",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.middlewares"
      },
      {
        "rel": "UserFunctions",
        "title": "MODEL_USERFUNCTION",
        "href": "https://api.ayoune.app/config/userfunctions",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.userfunctions"
      }
    ],
    "debugId": "6a62df0ff27d6098834b22bf",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_WEBRECEIVER",
        "href": "https://api.ayoune.app/config/webreceivers/65e0b086121b7d48fe15827d/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_WEBRECEIVER",
        "href": "https://api.ayoune.app/config/webreceivers/65e0b086121b7d48fe15827d/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "281",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 195.504527,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend