settingsAPI-Referenz

PUT/v2/settings/accesssystems

Zugangssystem ändern oder Aktion ausführen

Ändert eine vorhandene Zugangskonfiguration oder führt token (geheimen Bearer-Token ersetzen), pairing (fünfminütige Geräteerkennung starten/stoppen) oder preview (Entscheidung prüfen und protokollieren) aus. Für jedes entity ist id erforderlich. entity wählt den Vertrag. point verlangt eine Verbindung; rule verlangt Zugangspunkt, Ziel und Fünf-Minuten-Zeitfenster. Gerätezuteilungen können vorhandene Geräte deaktivieren; bei Gerätezuweisung nach Erkennung ist die gültige pairing-session erforderlich. Zielobjekte und Statuswerte müssen im Account verfügbar sein. Das comydo-Plugin und die Zugangsmigration müssen vorhanden sein.

Operation-ID put_v2_settings_accesssystems

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON

{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

Ressource: settings · setti
Levels: 3, 4
Dispatcher-Prüfung: Ja

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "de"
  ]
}

X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string

pattern: "^[a-f0-9]{32}$"

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Request Body

erforderlich

`application/json`

object

data Typ nicht eingeschränkt erforderlich

oneOf · Genau eine Variante muss passen

Variante 1 object

entity Typ nicht eingeschränkt erforderlich

Fester Wert: "connection"

name string erforderlich

Nicht leer nach trim; Steuerzeichen werden abgelehnt.

minLength: 1
maxLength: 120

enabled boolean erforderlich

provider Typ nicht eingeschränkt

Fester Wert: "comydo"

additional_connection boolean

id string erforderlich

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^accessconnection_[a-f0-9]{12}_-?[0-9]+$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 object

entity Typ nicht eingeschränkt erforderlich

Fester Wert: "point"

name string erforderlich

Nicht leer nach trim; Steuerzeichen werden abgelehnt.

minLength: 1
maxLength: 120

enabled boolean erforderlich

connection string erforderlich

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^accessconnection_[a-f0-9]{12}_-?[0-9]+$"

attendance_status integer | null

null oder ein aktueller Status aus attendance_statuses.

devices array

maxItems: 20
uniqueItems: true

Array-Elemente

string

pattern: "^[0-9a-fA-F]{8,20}$"

id string erforderlich

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^accesspoint_[a-f0-9]{12}_-?[0-9]+$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 3 object

entity Typ nicht eingeschränkt erforderlich

Fester Wert: "rule"

name string erforderlich

Nicht leer nach trim; Steuerzeichen werden abgelehnt.

minLength: 1
maxLength: 120

enabled boolean erforderlich

point string erforderlich

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^accesspoint_[a-f0-9]{12}_-?[0-9]+$"

target_type Typ nicht eingeschränkt erforderlich

Erlaubte Werte

"offer""room""root""category"

target Typ nicht eingeschränkt erforderlich

anyOf · Mindestens eine Variante muss passen

Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^offer_[a-f0-9]{12}_-?[0-9]+$"

Variante 2 string

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^room_[a-f0-9]{12}_-?[0-9]+$"

Variante 3 string

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^category_[a-f0-9]{12}_-?[0-9]+$"

minutes_before integer erforderlich

minimum: 0
maximum: 1440
multipleOf: 5

minutes_after integer erforderlich

minimum: 0
maximum: 1440
multipleOf: 5

id string erforderlich

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^accessrule_[a-f0-9]{12}_-?[0-9]+$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 4 object

entity Typ nicht eingeschränkt erforderlich

Fester Wert: "device"

name string erforderlich

Nicht leer nach trim; Steuerzeichen werden abgelehnt.

minLength: 1
maxLength: 120

enabled boolean erforderlich

point string erforderlich

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^accesspoint_[a-f0-9]{12}_-?[0-9]+$"

session string

id string erforderlich

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^accessdevice_[a-f0-9]{12}_-?[0-9]+$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 5 object

entity Typ nicht eingeschränkt erforderlich

Fester Wert: "token"

name string

Nicht leer nach trim; Steuerzeichen werden abgelehnt.

minLength: 1
maxLength: 120

enabled boolean

id string erforderlich

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^accessconnection_[a-f0-9]{12}_-?[0-9]+$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 6 object

entity Typ nicht eingeschränkt erforderlich

Fester Wert: "pairing"

name string

Nicht leer nach trim; Steuerzeichen werden abgelehnt.

minLength: 1
maxLength: 120

enabled boolean

action Typ nicht eingeschränkt erforderlich

Erlaubte Werte

"start""stop"

id string erforderlich

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^accessconnection_[a-f0-9]{12}_-?[0-9]+$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 7 object

entity Typ nicht eingeschränkt erforderlich

Fester Wert: "preview"

name string

Nicht leer nach trim; Steuerzeichen werden abgelehnt.

minLength: 1
maxLength: 120

enabled boolean

device_id string erforderlich

pattern: "^[0-9a-fA-F]{8,20}$"

content string erforderlich

maxLength: 96

id string erforderlich

Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID.

pattern: "^accessconnection_[a-f0-9]{12}_-?[0-9]+$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variantenauswahl · discriminator

{
  "propertyName": "entity"
}

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "entity": {
              "const": "connection"
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120,
              "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
            },
            "enabled": {
              "type": "boolean"
            },
            "provider": {
              "const": "comydo"
            },
            "additional_connection": {
              "type": "boolean"
            },
            "id": {
              "type": "string",
              "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
            }
          },
          "additionalProperties": true,
          "required": [
            "entity",
            "name",
            "enabled",
            "id"
          ]
        },
        {
          "type": "object",
          "properties": {
            "entity": {
              "const": "point"
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120,
              "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
            },
            "enabled": {
              "type": "boolean"
            },
            "connection": {
              "type": "string",
              "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
            },
            "attendance_status": {
              "type": [
                "integer",
                "null"
              ],
              "description": "null oder ein aktueller Status aus attendance_statuses."
            },
            "devices": {
              "type": "array",
              "maxItems": 20,
              "uniqueItems": true,
              "items": {
                "type": "string",
                "pattern": "^[0-9a-fA-F]{8,20}$"
              }
            },
            "id": {
              "type": "string",
              "pattern": "^accesspoint_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
            }
          },
          "additionalProperties": true,
          "required": [
            "entity",
            "name",
            "enabled",
            "connection",
            "id"
          ]
        },
        {
          "type": "object",
          "properties": {
            "entity": {
              "const": "rule"
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120,
              "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
            },
            "enabled": {
              "type": "boolean"
            },
            "point": {
              "type": "string",
              "pattern": "^accesspoint_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
            },
            "target_type": {
              "enum": [
                "offer",
                "room",
                "root",
                "category"
              ]
            },
            "target": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                },
                {
                  "type": "string",
                  "pattern": "^room_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                },
                {
                  "type": "string",
                  "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                }
              ]
            },
            "minutes_before": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1440,
              "multipleOf": 5
            },
            "minutes_after": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1440,
              "multipleOf": 5
            },
            "id": {
              "type": "string",
              "pattern": "^accessrule_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
            }
          },
          "additionalProperties": true,
          "required": [
            "entity",
            "name",
            "enabled",
            "point",
            "target_type",
            "target",
            "minutes_before",
            "minutes_after",
            "id"
          ]
        },
        {
          "type": "object",
          "properties": {
            "entity": {
              "const": "device"
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120,
              "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
            },
            "enabled": {
              "type": "boolean"
            },
            "point": {
              "type": "string",
              "pattern": "^accesspoint_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
            },
            "session": {
              "type": "string"
            },
            "id": {
              "type": "string",
              "pattern": "^accessdevice_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
            }
          },
          "additionalProperties": true,
          "required": [
            "entity",
            "name",
            "enabled",
            "point",
            "id"
          ]
        },
        {
          "type": "object",
          "properties": {
            "entity": {
              "const": "token"
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120,
              "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
            },
            "enabled": {
              "type": "boolean"
            },
            "id": {
              "type": "string",
              "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
            }
          },
          "additionalProperties": true,
          "required": [
            "entity",
            "id"
          ]
        },
        {
          "type": "object",
          "properties": {
            "entity": {
              "const": "pairing"
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120,
              "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
            },
            "enabled": {
              "type": "boolean"
            },
            "action": {
              "enum": [
                "start",
                "stop"
              ]
            },
            "id": {
              "type": "string",
              "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
            }
          },
          "additionalProperties": true,
          "required": [
            "entity",
            "action",
            "id"
          ]
        },
        {
          "type": "object",
          "properties": {
            "entity": {
              "const": "preview"
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120,
              "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
            },
            "enabled": {
              "type": "boolean"
            },
            "device_id": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8,20}$"
            },
            "content": {
              "type": "string",
              "maxLength": 96
            },
            "id": {
              "type": "string",
              "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
            }
          },
          "additionalProperties": true,
          "required": [
            "entity",
            "device_id",
            "content",
            "id"
          ]
        }
      ],
      "discriminator": {
        "propertyName": "entity"
      }
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

Zugangssystem ändern oder Aktion ausführen

{
  "data": {
    "entity": "point",
    "name": "Haupteingang",
    "enabled": true,
    "connection": "accessconnection_012345abcdef_123456",
    "attendance_status": null,
    "id": "accesspoint_012345abcdef_123456"
  }
}

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

entity-abhängig: öffentliche ID; neue Verbindung mit connection/Token, Tokenrotation mit Token, Pairing mit session/expires_at oder expires_at=0, Vorschau mit success/reason.

Response Header

`X-Edoobox-Revision`

Rotated account revision supplied for the next action in one reviewed sequence.

string

pattern: "^[a-f0-9]{32}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

`application/json`

object

success boolean

error boolean | string

error_code string

data object

id string

connection object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

token string

Geheimer Einmaltoken nur bei Neuerstellung/Rotation.

session string

expires_at integer

success boolean

reason string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "connection": {
          "type": "object",
          "properties": {},
          "additionalProperties": true
        },
        "token": {
          "type": "string",
          "writeOnly": false,
          "description": "Geheimer Einmaltoken nur bei Neuerstellung/Rotation."
        },
        "session": {
          "type": "string"
        },
        "expires_at": {
          "type": "integer"
        },
        "success": {
          "type": "boolean"
        },
        "reason": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "accesspoint_012345abcdef_123456"
  }
}

400application/json

Invalid request.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40006"
}

401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40103"
}

402application/json

Missing/invalid action data or subscription/operation restriction.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80100"
}

403application/json

Permission denied. Browser CORS rejection may have an empty body.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40340"
}

404application/json

Unknown resource/action or unsupported method.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80019"
}

409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80020"
}

429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

`Retry-After`

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "30"
  ]
}

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED42902"
}

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED50201"
}

503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Settings.php:2324updateSettings()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state

true

x-edoobox-sensitive-response-paths

[
  "/data/token"
]

x-edoobox-user-handoff

{
  "sensitivePaths": [
    "/data/token"
  ],
  "oneTime": true
}

x-edoobox-runtimeMutationGuard

true

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/06-admin-settings.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Settings.php",
  "method": "updateSettings",
  "line": 2324,
  "branch": {
    "file": "application/models/v2/Settings.php",
    "line": 2326
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "settings",
  "short": "setti",
  "checkedByDispatcher": true,
  "levels": [
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}

Vollständige Operation als JSON

{
  "operationId": "put_v2_settings_accesssystems",
  "summary": "Zugangssystem ändern oder Aktion ausführen",
  "description": "Ändert eine vorhandene Zugangskonfiguration oder führt token (geheimen Bearer-Token ersetzen), pairing (fünfminütige Geräteerkennung starten/stoppen) oder preview (Entscheidung prüfen und protokollieren) aus. Für jedes entity ist id erforderlich. entity wählt den Vertrag. point verlangt eine Verbindung; rule verlangt Zugangspunkt, Ziel und Fünf-Minuten-Zeitfenster. Gerätezuteilungen können vorhandene Geräte deaktivieren; bei Gerätezuweisung nach Erkennung ist die gültige pairing-session erforderlich. Zielobjekte und Statuswerte müssen im Account verfügbar sein. Das comydo-Plugin und die Zugangsmigration müssen vorhanden sein.",
  "tags": [
    "settings"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "entity-abhängig: öffentliche ID; neue Verbindung mit connection/Token, Tokenrotation mit Token, Pairing mit session/expires_at oder expires_at=0, Vorschau mit success/reason.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "accesspoint_012345abcdef_123456"
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "connection": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true
                  },
                  "token": {
                    "type": "string",
                    "writeOnly": false,
                    "description": "Geheimer Einmaltoken nur bei Neuerstellung/Rotation."
                  },
                  "session": {
                    "type": "string"
                  },
                  "expires_at": {
                    "type": "integer"
                  },
                  "success": {
                    "type": "boolean"
                  },
                  "reason": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "entity": {
                      "const": "connection"
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120,
                      "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
                    },
                    "enabled": {
                      "type": "boolean"
                    },
                    "provider": {
                      "const": "comydo"
                    },
                    "additional_connection": {
                      "type": "boolean"
                    },
                    "id": {
                      "type": "string",
                      "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "entity",
                    "name",
                    "enabled",
                    "id"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "entity": {
                      "const": "point"
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120,
                      "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
                    },
                    "enabled": {
                      "type": "boolean"
                    },
                    "connection": {
                      "type": "string",
                      "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                    },
                    "attendance_status": {
                      "type": [
                        "integer",
                        "null"
                      ],
                      "description": "null oder ein aktueller Status aus attendance_statuses."
                    },
                    "devices": {
                      "type": "array",
                      "maxItems": 20,
                      "uniqueItems": true,
                      "items": {
                        "type": "string",
                        "pattern": "^[0-9a-fA-F]{8,20}$"
                      }
                    },
                    "id": {
                      "type": "string",
                      "pattern": "^accesspoint_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "entity",
                    "name",
                    "enabled",
                    "connection",
                    "id"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "entity": {
                      "const": "rule"
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120,
                      "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
                    },
                    "enabled": {
                      "type": "boolean"
                    },
                    "point": {
                      "type": "string",
                      "pattern": "^accesspoint_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                    },
                    "target_type": {
                      "enum": [
                        "offer",
                        "room",
                        "root",
                        "category"
                      ]
                    },
                    "target": {
                      "anyOf": [
                        {
                          "type": "string",
                          "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                        },
                        {
                          "type": "string",
                          "pattern": "^room_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                        },
                        {
                          "type": "string",
                          "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                        }
                      ]
                    },
                    "minutes_before": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 1440,
                      "multipleOf": 5
                    },
                    "minutes_after": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 1440,
                      "multipleOf": 5
                    },
                    "id": {
                      "type": "string",
                      "pattern": "^accessrule_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "entity",
                    "name",
                    "enabled",
                    "point",
                    "target_type",
                    "target",
                    "minutes_before",
                    "minutes_after",
                    "id"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "entity": {
                      "const": "device"
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120,
                      "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
                    },
                    "enabled": {
                      "type": "boolean"
                    },
                    "point": {
                      "type": "string",
                      "pattern": "^accesspoint_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                    },
                    "session": {
                      "type": "string"
                    },
                    "id": {
                      "type": "string",
                      "pattern": "^accessdevice_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "entity",
                    "name",
                    "enabled",
                    "point",
                    "id"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "entity": {
                      "const": "token"
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120,
                      "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
                    },
                    "enabled": {
                      "type": "boolean"
                    },
                    "id": {
                      "type": "string",
                      "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "entity",
                    "id"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "entity": {
                      "const": "pairing"
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120,
                      "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
                    },
                    "enabled": {
                      "type": "boolean"
                    },
                    "action": {
                      "enum": [
                        "start",
                        "stop"
                      ]
                    },
                    "id": {
                      "type": "string",
                      "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "entity",
                    "action",
                    "id"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "entity": {
                      "const": "preview"
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120,
                      "description": "Nicht leer nach trim; Steuerzeichen werden abgelehnt."
                    },
                    "enabled": {
                      "type": "boolean"
                    },
                    "device_id": {
                      "type": "string",
                      "pattern": "^[0-9a-fA-F]{8,20}$"
                    },
                    "content": {
                      "type": "string",
                      "maxLength": 96
                    },
                    "id": {
                      "type": "string",
                      "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "entity",
                    "device_id",
                    "content",
                    "id"
                  ]
                }
              ],
              "discriminator": {
                "propertyName": "entity"
              }
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Zugangssystem ändern oder Aktion ausführen",
            "value": {
              "data": {
                "entity": "point",
                "name": "Haupteingang",
                "enabled": true,
                "connection": "accessconnection_012345abcdef_123456",
                "attendance_status": null,
                "id": "accesspoint_012345abcdef_123456"
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-sensitive-response-paths": [
    "/data/token"
  ],
  "x-edoobox-user-handoff": {
    "sensitivePaths": [
      "/data/token"
    ],
    "oneTime": true
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/06-admin-settings.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Settings.php",
    "method": "updateSettings",
    "line": 2324,
    "branch": {
      "file": "application/models/v2/Settings.php",
      "line": 2326
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "settings",
    "short": "setti",
    "checkedByDispatcher": true,
    "levels": [
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "entity": "point",
    "name": "Haupteingang",
    "enabled": true,
    "connection": "accessconnection_012345abcdef_123456",
    "attendance_status": null,
    "id": "accesspoint_012345abcdef_123456"
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'PUT' \
  --url "${API_ORIGIN%/}"'/v2/settings/accesssystems' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/settings/accesssystems";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "entity": "point",
    "name": "Haupteingang",
    "enabled": true,
    "connection": "accessconnection_012345abcdef_123456",
    "attendance_status": null,
    "id": "accesspoint_012345abcdef_123456"
  }
});
const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/settings/accesssystems"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"entity\":\"point\",\"name\":\"Haupteingang\",\"enabled\":true,\"connection\":\"accessconnection_012345abcdef_123456\",\"attendance_status\":null,\"id\":\"accesspoint_012345abcdef_123456\"}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="PUT", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/settings/accesssystems";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "entity": "point",
    "name": "Haupteingang",
    "enabled": true,
    "connection": "accessconnection_012345abcdef_123456",
    "attendance_status": null,
    "id": "accesspoint_012345abcdef_123456"
  }
});
const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/settings/accesssystems"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"entity\":\"point\",\"name\":\"Haupteingang\",\"enabled\":true,\"connection\":\"accessconnection_012345abcdef_123456\",\"attendance_status\":null,\"id\":\"accesspoint_012345abcdef_123456\"}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="PUT", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.