settingsAPI-Referenz

GET/v2/settings/accesssystems

Zugangssysteme und Prüfprotokoll abrufen

Liest die Zugangssystem-Konfiguration des Accounts mit Verbindungen, Zugangspunkten, Regeln, Geräten, Räumen und verfügbaren Präsenzstatus sowie den letzten höchstens 200 Zugangsentscheidungen. Liefert öffentliche v2-IDs und Webhook-URLs; geheime Bearer-Tokens werden nicht ausgegeben. Die Accountmigration für Zugangssysteme muss vorhanden sein.

Operation-ID get_v2_settings_accesssystems

Vertrag & Verhalten

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

GET-Verhalten laut Spezifikation

read

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: 1, 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"
  ]
}

Request Body

Kein Request Body in der Spezifikation beschrieben.

Antworten

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

200application/json

Vollständiger Konfigurations-Snapshot mit server_time als Unix-Sekunden.

`application/json`

object

success boolean

error boolean | string

error_code string

data object

connections array erforderlich

Array-Elemente

object

id string

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

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

name string

enabled boolean

provider string

webhook_path string

webhook_url string

authentication Typ nicht eingeschränkt

Fester Wert: "bearer"

pairing_until integer

pairing_session string

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

points array erforderlich

Array-Elemente

object

id string

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

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

name string

enabled boolean

connection string

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

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

attendance_status integer | null

devices array

Array-Elemente

string

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

rules array erforderlich

Array-Elemente

object

id string

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

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

name string

enabled boolean

point string

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

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

target_type string

target string

minutes_before integer

minutes_after integer

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

devices array erforderlich

Array-Elemente

object

id string

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

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

connection string

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

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

point string | null

device_id string

name string

enabled boolean

last_seen_at integer

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

decisions array erforderlich

Array-Elemente

object

id string

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

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

connection string

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

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

point string | null

user string | null

booking string | null

date string | null

time integer

success boolean

reason string

source string

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

rooms array erforderlich

Array-Elemente

object

id string

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

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

name string

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

attendance_statuses array erforderlich

Array-Elemente

object

status integer

name string

symbol string

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

server_time integer erforderlich

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": {
        "connections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
              },
              "name": {
                "type": "string"
              },
              "enabled": {
                "type": "boolean"
              },
              "provider": {
                "type": "string"
              },
              "webhook_path": {
                "type": "string"
              },
              "webhook_url": {
                "type": "string"
              },
              "authentication": {
                "const": "bearer"
              },
              "pairing_until": {
                "type": "integer"
              },
              "pairing_session": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "points": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^accesspoint_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
              },
              "name": {
                "type": "string"
              },
              "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"
                ]
              },
              "devices": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true
          }
        },
        "rules": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^accessrule_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
              },
              "name": {
                "type": "string"
              },
              "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": {
                "type": "string"
              },
              "target": {
                "type": "string"
              },
              "minutes_before": {
                "type": "integer"
              },
              "minutes_after": {
                "type": "integer"
              }
            },
            "additionalProperties": true
          }
        },
        "devices": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^accessdevice_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
              },
              "connection": {
                "type": "string",
                "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
              },
              "point": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "device_id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "enabled": {
                "type": "boolean"
              },
              "last_seen_at": {
                "type": "integer"
              }
            },
            "additionalProperties": true
          }
        },
        "decisions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^accessdecision_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
              },
              "connection": {
                "type": "string",
                "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
              },
              "point": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "user": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "booking": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "date": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "time": {
                "type": "integer"
              },
              "success": {
                "type": "boolean"
              },
              "reason": {
                "type": "string"
              },
              "source": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "rooms": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^room_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
              },
              "name": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "attendance_statuses": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "symbol": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "server_time": {
          "type": "integer"
        }
      },
      "additionalProperties": true,
      "required": [
        "connections",
        "points",
        "rules",
        "decisions",
        "rooms",
        "devices",
        "server_time",
        "attendance_statuses"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "connections": [],
    "points": [],
    "rules": [],
    "decisions": [],
    "rooms": [],
    "devices": [],
    "attendance_statuses": [],
    "server_time": 1792620000
  }
}

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"
}

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"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Settings.php:2408getSettings()

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

false

x-edoobox-mutationReview

{
  "source": {
    "file": "application/models/v2/Accesssystems.php",
    "line": 27
  },
  "reason": "GET account access-system configuration only; write methods are separate."
}

x-edoobox-runtimeMutationGuard

false

x-edoobox-get-effect

"read"

x-edoobox-documentationReview

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

x-edoobox-source

{
  "file": "application/models/v2/Settings.php",
  "method": "getSettings",
  "line": 2408,
  "branch": {
    "file": "application/models/v2/Settings.php",
    "line": 2410
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

true

x-edoobox-safeForAutomation

true

x-edoobox-permission

{
  "resource": "settings",
  "short": "setti",
  "checkedByDispatcher": true,
  "levels": [
    1,
    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": "get_v2_settings_accesssystems",
  "summary": "Zugangssysteme und Prüfprotokoll abrufen",
  "description": "Liest die Zugangssystem-Konfiguration des Accounts mit Verbindungen, Zugangspunkten, Regeln, Geräten, Räumen und verfügbaren Präsenzstatus sowie den letzten höchstens 200 Zugangsentscheidungen. Liefert öffentliche v2-IDs und Webhook-URLs; geheime Bearer-Tokens werden nicht ausgegeben. Die Accountmigration für Zugangssysteme muss 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"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Vollständiger Konfigurations-Snapshot mit server_time als Unix-Sekunden.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "connections": [],
              "points": [],
              "rules": [],
              "decisions": [],
              "rooms": [],
              "devices": [],
              "attendance_statuses": [],
              "server_time": 1792620000
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "connections": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                        },
                        "name": {
                          "type": "string"
                        },
                        "enabled": {
                          "type": "boolean"
                        },
                        "provider": {
                          "type": "string"
                        },
                        "webhook_path": {
                          "type": "string"
                        },
                        "webhook_url": {
                          "type": "string"
                        },
                        "authentication": {
                          "const": "bearer"
                        },
                        "pairing_until": {
                          "type": "integer"
                        },
                        "pairing_session": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "points": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^accesspoint_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                        },
                        "name": {
                          "type": "string"
                        },
                        "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"
                          ]
                        },
                        "devices": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "rules": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^accessrule_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                        },
                        "name": {
                          "type": "string"
                        },
                        "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": {
                          "type": "string"
                        },
                        "target": {
                          "type": "string"
                        },
                        "minutes_before": {
                          "type": "integer"
                        },
                        "minutes_after": {
                          "type": "integer"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "devices": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^accessdevice_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                        },
                        "connection": {
                          "type": "string",
                          "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                        },
                        "point": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "device_id": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "enabled": {
                          "type": "boolean"
                        },
                        "last_seen_at": {
                          "type": "integer"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "decisions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^accessdecision_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                        },
                        "connection": {
                          "type": "string",
                          "pattern": "^accessconnection_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                        },
                        "point": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "user": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "booking": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "date": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "time": {
                          "type": "integer"
                        },
                        "success": {
                          "type": "boolean"
                        },
                        "reason": {
                          "type": "string"
                        },
                        "source": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "rooms": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^room_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Account; keine interne Datenbank-ID."
                        },
                        "name": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "attendance_statuses": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "integer"
                        },
                        "name": {
                          "type": "string"
                        },
                        "symbol": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "server_time": {
                    "type": "integer"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "connections",
                  "points",
                  "rules",
                  "decisions",
                  "rooms",
                  "devices",
                  "server_time",
                  "attendance_statuses"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "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"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": false,
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Accesssystems.php",
      "line": 27
    },
    "reason": "GET account access-system configuration only; write methods are separate."
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/06-admin-settings.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Settings.php",
    "method": "getSettings",
    "line": 2408,
    "branch": {
      "file": "application/models/v2/Settings.php",
      "line": 2410
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "settings",
    "short": "setti",
    "checkedByDispatcher": true,
    "levels": [
      1,
      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.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/settings/accesssystems' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}"

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
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");
const response = await fetch(url, { method: "GET", headers, 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.
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"]

# 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="GET")
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.
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");
const response = await fetch(url, { method: "GET", headers, 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.
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"]

# 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="GET")
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.