POST/v2/apiaccess

API-Zugang anlegen

Erzeugt serverseitig ein neues key_/sec_-Paar. Ohne permission bzw. mit den dokumentierten leeren Legacy-Werten wird das konto-eigene Standardprofil verwendet; eine explizite permission muss diesem Konto gehören. Das Klartext-Secret wird nur bei dieser Erstellung ausgegeben.

Operation-ID post_v2_apiaccess

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: apiaccess · apia
Levels: 2, 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

anyOf · Mindestens eine Variante muss passen

Variante 1 object

Source-declared fields; action-specific and account validation still apply.

minProperties: 1

id kein Wert zulässig

status Typ nicht eingeschränkt

Kanonischer Typ nach Normalisierung: boolean. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.

Schema-Beispiel

false

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 36,
  "x-edoobox-canonicalType": "boolean",
  "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction."
}

api_key Typ nicht eingeschränkt beim Ändern nicht schreibbar

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Maximal gespeicherte Länge: 250. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.

The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.

Schema-Beispiel

"Example"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-maxStoredLength": 250,
  "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
  "x-edoobox-writableOnUpdate": false,
  "x-edoobox-sourceLine": 45
}

permission Typ nicht eingeschränkt

An existing account-owned public permission ID selects that role. Omitted permission or the explicit legacy values null/false/0/"0"/"" resolve the account default, which must also exist in this account.

anyOf · Mindestens eine Variante muss passen

Variante 1 string

Public permission v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook.

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

Variante 2 Typ nicht eingeschränkt

Erlaubte Werte

nullfalse0"0"""

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Apiaccess.php",
      "line": 55,
      "lineEnd": 64,
      "reason": "Input getter and output setter use the permission public ID type; PUT dispatches its dedicated hook.",
      "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
    },
    {
      "file": "application/models/v2/Apiaccessfunc.php",
      "line": 6,
      "lineEnd": 29,
      "reason": "Before insert validates explicit typed permission against normalized input and account ownership, or resolves a same-account default for omitted/legacy empty input.",
      "sha256": "35bb0286908910683a9d5d56c0f5ac138d2b47d759417623cbd918bbc17479b2"
    },
    {
      "file": "application/models/v2/Apiaccessfunc.php",
      "line": 31,
      "lineEnd": 56,
      "reason": "PUT uses strict permission type and same-account existence query; invalid role throws ED80100 with require.permission=false.",
      "sha256": "35bb0286908910683a9d5d56c0f5ac138d2b47d759417623cbd918bbc17479b2"
    },
    {
      "file": "application/models/v2/Apiaccess.php",
      "line": 79,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
    },
    {
      "file": "application/models/v2/Apiaccess.php",
      "line": 117,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
    },
    {
      "file": "docs/openapi/reviews/identity-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
    }
  ]
}

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

Variante 2 array

minItems: 1
maxItems: 100

Array-Elemente

object

Source-declared fields; action-specific and account validation still apply.

id kein Wert zulässig

status Typ nicht eingeschränkt

Kanonischer Typ nach Normalisierung: boolean. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.

Schema-Beispiel

false

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 36,
  "x-edoobox-canonicalType": "boolean",
  "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction."
}

api_key Typ nicht eingeschränkt beim Ändern nicht schreibbar

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Maximal gespeicherte Länge: 250. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.

Schema-Beispiel

"Example"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-maxStoredLength": 250,
  "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
  "x-edoobox-writableOnUpdate": false,
  "x-edoobox-sourceLine": 45
}

permission Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 string

Public permission v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook.

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

Variante 2 Typ nicht eingeschränkt

Erlaubte Werte

nullfalse0"0"""

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Apiaccess.php",
      "line": 55,
      "lineEnd": 64,
      "reason": "Input getter and output setter use the permission public ID type; PUT dispatches its dedicated hook.",
      "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
    },
    {
      "file": "application/models/v2/Apiaccessfunc.php",
      "line": 6,
      "lineEnd": 29,
      "reason": "Before insert validates explicit typed permission against normalized input and account ownership, or resolves a same-account default for omitted/legacy empty input.",
      "sha256": "35bb0286908910683a9d5d56c0f5ac138d2b47d759417623cbd918bbc17479b2"
    },
    {
      "file": "application/models/v2/Apiaccessfunc.php",
      "line": 31,
      "lineEnd": 56,
      "reason": "PUT uses strict permission type and same-account existence query; invalid role throws ED80100 with require.permission=false.",
      "sha256": "35bb0286908910683a9d5d56c0f5ac138d2b47d759417623cbd918bbc17479b2"
    },
    {
      "file": "application/models/v2/Apiaccess.php",
      "line": 79,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
    },
    {
      "file": "application/models/v2/Apiaccess.php",
      "line": 117,
      "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
      "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
    },
    {
      "file": "docs/openapi/reviews/identity-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
    }
  ]
}

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

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-readOnlyFields": [],
  "x-edoobox-clientRestriction": "The server-generated id is forbidden. insert:false fields are readOnly and tolerated for existing Vue payloads because the API skips them."
}

id string

Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.

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

Schema-Beispiel

"apiaccess_012345abcdef_123456"

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": false,
            "status": {
              "x-edoobox-schemaStatus": "source-inferred",
              "x-edoobox-sourceLine": 36,
              "x-edoobox-canonicalType": "boolean",
              "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
              "examples": [
                false
              ]
            },
            "api_key": {
              "x-edoobox-canonicalType": "string",
              "x-edoobox-maxStoredLength": 250,
              "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
              "examples": [
                "Example"
              ],
              "x-edoobox-writableOnUpdate": false,
              "x-edoobox-sourceLine": 45
            },
            "permission": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^permission_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Public permission v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook."
                },
                {
                  "enum": [
                    null,
                    false,
                    0,
                    "0",
                    ""
                  ]
                }
              ],
              "description": "An existing account-owned public permission ID selects that role. Omitted permission or the explicit legacy values null/false/0/\"0\"/\"\" resolve the account default, which must also exist in this account.",
              "x-edoobox-contractSource": [
                {
                  "file": "application/models/v2/Apiaccess.php",
                  "line": 55,
                  "lineEnd": 64,
                  "reason": "Input getter and output setter use the permission public ID type; PUT dispatches its dedicated hook.",
                  "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
                },
                {
                  "file": "application/models/v2/Apiaccessfunc.php",
                  "line": 6,
                  "lineEnd": 29,
                  "reason": "Before insert validates explicit typed permission against normalized input and account ownership, or resolves a same-account default for omitted/legacy empty input.",
                  "sha256": "35bb0286908910683a9d5d56c0f5ac138d2b47d759417623cbd918bbc17479b2"
                },
                {
                  "file": "application/models/v2/Apiaccessfunc.php",
                  "line": 31,
                  "lineEnd": 56,
                  "reason": "PUT uses strict permission type and same-account existence query; invalid role throws ED80100 with require.permission=false.",
                  "sha256": "35bb0286908910683a9d5d56c0f5ac138d2b47d759417623cbd918bbc17479b2"
                },
                {
                  "file": "application/models/v2/Apiaccess.php",
                  "line": 79,
                  "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                  "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
                },
                {
                  "file": "application/models/v2/Apiaccess.php",
                  "line": 117,
                  "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                  "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
                },
                {
                  "file": "docs/openapi/reviews/identity-fields.json",
                  "line": 1,
                  "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                  "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                }
              ]
            }
          },
          "additionalProperties": true,
          "description": "Source-declared fields; action-specific and account validation still apply.",
          "minProperties": 1
        },
        {
          "type": "array",
          "minItems": 1,
          "maxItems": 100,
          "items": {
            "type": "object",
            "properties": {
              "id": false,
              "status": {
                "x-edoobox-schemaStatus": "source-inferred",
                "x-edoobox-sourceLine": 36,
                "x-edoobox-canonicalType": "boolean",
                "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                "examples": [
                  false
                ]
              },
              "api_key": {
                "x-edoobox-canonicalType": "string",
                "x-edoobox-maxStoredLength": 250,
                "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
                "examples": [
                  "Example"
                ],
                "x-edoobox-writableOnUpdate": false,
                "x-edoobox-sourceLine": 45
              },
              "permission": {
                "anyOf": [
                  {
                    "type": "string",
                    "pattern": "^permission_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Public permission v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook."
                  },
                  {
                    "enum": [
                      null,
                      false,
                      0,
                      "0",
                      ""
                    ]
                  }
                ],
                "description": "An existing account-owned public permission ID selects that role. Omitted permission or the explicit legacy values null/false/0/\"0\"/\"\" resolve the account default, which must also exist in this account.",
                "x-edoobox-contractSource": [
                  {
                    "file": "application/models/v2/Apiaccess.php",
                    "line": 55,
                    "lineEnd": 64,
                    "reason": "Input getter and output setter use the permission public ID type; PUT dispatches its dedicated hook.",
                    "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
                  },
                  {
                    "file": "application/models/v2/Apiaccessfunc.php",
                    "line": 6,
                    "lineEnd": 29,
                    "reason": "Before insert validates explicit typed permission against normalized input and account ownership, or resolves a same-account default for omitted/legacy empty input.",
                    "sha256": "35bb0286908910683a9d5d56c0f5ac138d2b47d759417623cbd918bbc17479b2"
                  },
                  {
                    "file": "application/models/v2/Apiaccessfunc.php",
                    "line": 31,
                    "lineEnd": 56,
                    "reason": "PUT uses strict permission type and same-account existence query; invalid role throws ED80100 with require.permission=false.",
                    "sha256": "35bb0286908910683a9d5d56c0f5ac138d2b47d759417623cbd918bbc17479b2"
                  },
                  {
                    "file": "application/models/v2/Apiaccess.php",
                    "line": 79,
                    "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                    "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
                  },
                  {
                    "file": "application/models/v2/Apiaccess.php",
                    "line": 117,
                    "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                    "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
                  },
                  {
                    "file": "docs/openapi/reviews/identity-fields.json",
                    "line": 1,
                    "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                    "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                  }
                ]
              }
            },
            "additionalProperties": true,
            "description": "Source-declared fields; action-specific and account validation still apply."
          }
        }
      ],
      "x-edoobox-readOnlyFields": [],
      "x-edoobox-clientRestriction": "The server-generated id is forbidden. insert:false fields are readOnly and tolerated for existing Vue payloads because the API skips them."
    },
    "id": {
      "type": "string",
      "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
      "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
      "examples": [
        "apiaccess_012345abcdef_123456"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

API-Zugang anlegen

{
  "data": {
    "status": false,
    "permission": "permission_012345abcdef_123456"
  }
}

Antworten

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

200application/json

Nativer Insert-Bericht, ergänzt um das serverseitig erzeugte api_key/api_secret-Paar. Bei Batch-Inserts enthält data zusätzlich die einzelnen Insert-Berichte; Klartext-Secret ist sensibel.

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

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

insert boolean

api_key string erforderlich sensibler Wert

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

api_secret string erforderlich sensibler Wert

Nur diese Erstellung gibt das Klartext-Secret aus; sicher ablegen und nicht protokollieren.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

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",
      "required": [
        "api_key",
        "api_secret"
      ],
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^api_[a-f0-9]{12}_-?[0-9]+$"
        },
        "insert": {
          "type": "boolean"
        },
        "api_key": {
          "type": "string",
          "x-edoobox-sensitive": true
        },
        "api_secret": {
          "type": "string",
          "x-edoobox-sensitive": true,
          "description": "Nur diese Erstellung gibt das Klartext-Secret aus; sicher ablegen und nicht protokollieren."
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "api_012345abcdef_123456",
    "insert": true,
    "api_key": "key_SYNTHETIC_NOT_A_CREDENTIAL",
    "api_secret": "sec_SYNTHETIC_NOT_A_CREDENTIAL"
  }
}

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/Apiaccess.php:79postApiaccess()

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-sensitiveResponseFields

[
  "api_key",
  "api_secret"
]

x-edoobox-user-handoff

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

x-edoobox-sensitive-response-paths

[
  "/data/api_key",
  "/data/api_secret"
]

x-edoobox-runtimeMutationGuard

true

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/05-auth.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Apiaccess.php",
  "method": "postApiaccess",
  "line": 79
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "apiaccess",
  "short": "apia",
  "checkedByDispatcher": true,
  "levels": [
    2,
    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": "post_v2_apiaccess",
  "summary": "API-Zugang anlegen",
  "description": "Erzeugt serverseitig ein neues key_/sec_-Paar. Ohne permission bzw. mit den dokumentierten leeren Legacy-Werten wird das konto-eigene Standardprofil verwendet; eine explizite permission muss diesem Konto gehören. Das Klartext-Secret wird nur bei dieser Erstellung ausgegeben.",
  "tags": [
    "apiaccess"
  ],
  "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": "Nativer Insert-Bericht, ergänzt um das serverseitig erzeugte api_key/api_secret-Paar. Bei Batch-Inserts enthält data zusätzlich die einzelnen Insert-Berichte; Klartext-Secret ist sensibel.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "api_012345abcdef_123456",
              "insert": true,
              "api_key": "key_SYNTHETIC_NOT_A_CREDENTIAL",
              "api_secret": "sec_SYNTHETIC_NOT_A_CREDENTIAL"
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "required": [
                  "api_key",
                  "api_secret"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^api_[a-f0-9]{12}_-?[0-9]+$"
                  },
                  "insert": {
                    "type": "boolean"
                  },
                  "api_key": {
                    "type": "string",
                    "x-edoobox-sensitive": true
                  },
                  "api_secret": {
                    "type": "string",
                    "x-edoobox-sensitive": true,
                    "description": "Nur diese Erstellung gibt das Klartext-Secret aus; sicher ablegen und nicht protokollieren."
                  }
                },
                "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": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": false,
                    "status": {
                      "x-edoobox-schemaStatus": "source-inferred",
                      "x-edoobox-sourceLine": 36,
                      "x-edoobox-canonicalType": "boolean",
                      "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                      "examples": [
                        false
                      ]
                    },
                    "api_key": {
                      "x-edoobox-canonicalType": "string",
                      "x-edoobox-maxStoredLength": 250,
                      "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
                      "examples": [
                        "Example"
                      ],
                      "x-edoobox-writableOnUpdate": false,
                      "x-edoobox-sourceLine": 45
                    },
                    "permission": {
                      "anyOf": [
                        {
                          "type": "string",
                          "pattern": "^permission_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Public permission v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook."
                        },
                        {
                          "enum": [
                            null,
                            false,
                            0,
                            "0",
                            ""
                          ]
                        }
                      ],
                      "description": "An existing account-owned public permission ID selects that role. Omitted permission or the explicit legacy values null/false/0/\"0\"/\"\" resolve the account default, which must also exist in this account.",
                      "x-edoobox-contractSource": [
                        {
                          "file": "application/models/v2/Apiaccess.php",
                          "line": 55,
                          "lineEnd": 64,
                          "reason": "Input getter and output setter use the permission public ID type; PUT dispatches its dedicated hook.",
                          "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
                        },
                        {
                          "file": "application/models/v2/Apiaccessfunc.php",
                          "line": 6,
                          "lineEnd": 29,
                          "reason": "Before insert validates explicit typed permission against normalized input and account ownership, or resolves a same-account default for omitted/legacy empty input.",
                          "sha256": "35bb0286908910683a9d5d56c0f5ac138d2b47d759417623cbd918bbc17479b2"
                        },
                        {
                          "file": "application/models/v2/Apiaccessfunc.php",
                          "line": 31,
                          "lineEnd": 56,
                          "reason": "PUT uses strict permission type and same-account existence query; invalid role throws ED80100 with require.permission=false.",
                          "sha256": "35bb0286908910683a9d5d56c0f5ac138d2b47d759417623cbd918bbc17479b2"
                        },
                        {
                          "file": "application/models/v2/Apiaccess.php",
                          "line": 79,
                          "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                          "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
                        },
                        {
                          "file": "application/models/v2/Apiaccess.php",
                          "line": 117,
                          "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                          "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
                        },
                        {
                          "file": "docs/openapi/reviews/identity-fields.json",
                          "line": 1,
                          "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                          "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                        }
                      ]
                    }
                  },
                  "additionalProperties": true,
                  "description": "Source-declared fields; action-specific and account validation still apply.",
                  "minProperties": 1
                },
                {
                  "type": "array",
                  "minItems": 1,
                  "maxItems": 100,
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": false,
                      "status": {
                        "x-edoobox-schemaStatus": "source-inferred",
                        "x-edoobox-sourceLine": 36,
                        "x-edoobox-canonicalType": "boolean",
                        "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                        "examples": [
                          false
                        ]
                      },
                      "api_key": {
                        "x-edoobox-canonicalType": "string",
                        "x-edoobox-maxStoredLength": 250,
                        "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
                        "examples": [
                          "Example"
                        ],
                        "x-edoobox-writableOnUpdate": false,
                        "x-edoobox-sourceLine": 45
                      },
                      "permission": {
                        "anyOf": [
                          {
                            "type": "string",
                            "pattern": "^permission_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Public permission v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook."
                          },
                          {
                            "enum": [
                              null,
                              false,
                              0,
                              "0",
                              ""
                            ]
                          }
                        ],
                        "description": "An existing account-owned public permission ID selects that role. Omitted permission or the explicit legacy values null/false/0/\"0\"/\"\" resolve the account default, which must also exist in this account.",
                        "x-edoobox-contractSource": [
                          {
                            "file": "application/models/v2/Apiaccess.php",
                            "line": 55,
                            "lineEnd": 64,
                            "reason": "Input getter and output setter use the permission public ID type; PUT dispatches its dedicated hook.",
                            "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
                          },
                          {
                            "file": "application/models/v2/Apiaccessfunc.php",
                            "line": 6,
                            "lineEnd": 29,
                            "reason": "Before insert validates explicit typed permission against normalized input and account ownership, or resolves a same-account default for omitted/legacy empty input.",
                            "sha256": "35bb0286908910683a9d5d56c0f5ac138d2b47d759417623cbd918bbc17479b2"
                          },
                          {
                            "file": "application/models/v2/Apiaccessfunc.php",
                            "line": 31,
                            "lineEnd": 56,
                            "reason": "PUT uses strict permission type and same-account existence query; invalid role throws ED80100 with require.permission=false.",
                            "sha256": "35bb0286908910683a9d5d56c0f5ac138d2b47d759417623cbd918bbc17479b2"
                          },
                          {
                            "file": "application/models/v2/Apiaccess.php",
                            "line": 79,
                            "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                            "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
                          },
                          {
                            "file": "application/models/v2/Apiaccess.php",
                            "line": 117,
                            "reason": "Resource POST/PUT dispatch reachability and preconditions; field contracts apply to parent resource, not sub-resource actions.",
                            "sha256": "4bf3c13ed924a1d30c97aed171de3fbce40697f633e7bad907dc514ea61b4c6b"
                          },
                          {
                            "file": "docs/openapi/reviews/identity-fields.json",
                            "line": 1,
                            "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                            "sha256": "0928d996b9c89e19be93905970488d6b869ac62bcbc4b6f260cd13a5c385a055"
                          }
                        ]
                      }
                    },
                    "additionalProperties": true,
                    "description": "Source-declared fields; action-specific and account validation still apply."
                  }
                }
              ],
              "x-edoobox-readOnlyFields": [],
              "x-edoobox-clientRestriction": "The server-generated id is forbidden. insert:false fields are readOnly and tolerated for existing Vue payloads because the API skips them."
            },
            "id": {
              "type": "string",
              "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
              "examples": [
                "apiaccess_012345abcdef_123456"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "API-Zugang anlegen",
            "value": {
              "data": {
                "status": false,
                "permission": "permission_012345abcdef_123456"
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-sensitiveResponseFields": [
    "api_key",
    "api_secret"
  ],
  "x-edoobox-user-handoff": {
    "sensitivePaths": [
      "/data/api_key",
      "/data/api_secret"
    ],
    "oneTime": true
  },
  "x-edoobox-sensitive-response-paths": [
    "/data/api_key",
    "/data/api_secret"
  ],
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/05-auth.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Apiaccess.php",
    "method": "postApiaccess",
    "line": 79
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "apiaccess",
    "short": "apia",
    "checkedByDispatcher": true,
    "levels": [
      2,
      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": {
    "status": false,
    "permission": "permission_012345abcdef_123456"
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/apiaccess' \
  --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/apiaccess";
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": {
    "status": false,
    "permission": "permission_012345abcdef_123456"
  }
});
const response = await fetch(url, { method: "POST", 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/apiaccess"
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\":{\"status\":false,\"permission\":\"permission_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="POST", 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/apiaccess";
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": {
    "status": false,
    "permission": "permission_012345abcdef_123456"
  }
});
const response = await fetch(url, { method: "POST", 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/apiaccess"
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\":{\"status\":false,\"permission\":\"permission_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="POST", 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.