aYOUne
← CMS API

Images

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

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": "65e0afca121b7d48fe1556ee",
    "productDefault": false,
    "type": "stockimage",
    "mainColor": [],
    "colorPalette": [],
    "face": false,
    "facePos": [],
    "tags": [],
    "isCloudFile": false,
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:24:42.851Z",
    "updatedAt": "2024-02-29T16:24:42.851Z",
    "slug": "bild-fe1556ee"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://cms-api.ayoune.app/images/65e0afca121b7d48fe1556ee",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "rel": "Products",
        "title": "MODEL_PRODUCT",
        "href": "https://api.ayoune.app/pim/products",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pim.products"
      },
      {
        "rel": "ProductGroups",
        "title": "MODEL_PRODUCTGROUP",
        "href": "https://api.ayoune.app/config/productgroups",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.productgroups"
      },
      {
        "rel": "ProductDivisions",
        "title": "MODEL_PRODUCTDIVISION",
        "href": "https://api.ayoune.app/config/productdivisions",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.productdivisions"
      },
      {
        "rel": "Publications",
        "title": "MODEL_PUBLICATION",
        "href": "https://api.ayoune.app/marketing/publications",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "marketing.publications"
      },
      {
        "rel": "ContentCategories",
        "title": "MODEL_CONTENTCATEGORY",
        "href": "https://api.ayoune.app/config/contentcategories",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.contentcategories"
      }
    ],
    "debugId": "6a8e600dfa8f1510f1a4611c",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_IMAGE",
        "href": "https://api.ayoune.app/cms/images/65e0afca121b7d48fe1556ee/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_IMAGE",
        "href": "https://api.ayoune.app/cms/images/65e0afca121b7d48fe1556ee",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.45.0",
      "core": "2026.320.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2369",
      "reset": "1787719173",
      "resetDate": "Wed Aug 26 2026"
    },
    "responseTime": 82.232299,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend