aYOUne
← Konfiguration API

Intermediaries

Singular: Intermediary — 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": {
    "_id": "65e0b026121b7d48fe15739a",
    "company": "",
    "title": "",
    "salutation": "",
    "first_name": "",
    "last_name": "",
    "approved": false,
    "active": false,
    "street": "",
    "zip": "",
    "city": "",
    "country": "Deutschland",
    "state": "",
    "phone": "",
    "fax": "",
    "cell": "",
    "info": "",
    "website": "",
    "status": "Neu",
    "source": "",
    "note": "",
    "jahresumsatz": "",
    "branche": "",
    "createdBy": "6045f4d25704710012485569",
    "addons": [],
    "createdAt": "2024-02-29T16:26:14.431Z",
    "updatedAt": "2024-02-29T16:26:14.431Z",
    "shortID": "LG_JLgf"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/intermediaries/65e0b026121b7d48fe15739a",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "CommissionGroups",
        "title": "MODEL_COMMISSIONGROUP",
        "href": "https://api.ayoune.app/config/commissiongroups",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.commissiongroups"
      },
      {
        "rel": "Intermediaries",
        "title": "MODEL_INTERMEDIARY",
        "href": "https://api.ayoune.app/config/intermediaries",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.intermediaries"
      },
      {
        "rel": "Intermediaries",
        "title": "MODEL_INTERMEDIARY",
        "href": "https://api.ayoune.app/config/intermediaries",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.intermediaries"
      }
    ],
    "debugId": "6a62ddbdf27d6098834aca62",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_INTERMEDIARY",
        "href": "https://api.ayoune.app/config/intermediaries/65e0b026121b7d48fe15739a/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_INTERMEDIARY",
        "href": "https://api.ayoune.app/config/intermediaries/65e0b026121b7d48fe15739a/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1427",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 301.814431,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend