authAPI-Referenz

GET/v2/auth/webhook/pingen/{token}

Pingen-Briefstatus und Kosten übernehmen

Empfängt einen Pingen-Rückruf. Das Pfadsegment token ist hier tatsächlich der Status-/Ereignistyp (z. B. send, error, not_deliverable), kein Authentifizierungstoken. data.relationships.letter.data.id identifiziert den externen Brief. Lädt dessen Status bei Pingen, aktualisiert lokalen Briefstatus und kann bei Rechnungen/Mahnungen Portokosten buchen. Der GET-Alias führt denselben schreibenden Handler aus; nicht als Leseabfrage verwenden. GET liest die verschachtelte Query-data-Struktur, POST den JSON-Body; ein GET-JSON-Body wird vom Dispatcher nicht übernommen.

Operation-ID get_v2_auth_webhook_pingen_token

Vertrag & Verhalten

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

Dieser GET-Aufruf kann Zustand verändern. Die HTTP-Methode allein kennzeichnet hier keinen reinen Lesezugriff.

GET-Verhalten laut Spezifikation

business-mutation

Authentifizierung

Für diesen Endpunkt sind keine OpenAPI-Security-Schemas vorgeschrieben. Weitere Voraussetzungen stehen in den Parametern und den Metadaten.

Berechtigungen

No account-JWT resource permission levels are applied. Authentication requirements, if any, are defined by this route source-specific boundary and dedicated security scheme.

Levels: Keine Account-Level angegeben
Dispatcher-Prüfung: Nein

Parameter

Pfadparameter

tokenerforderlich

Legacy-Name token im Pfad.

string

Status-/Ereignistyp des Pingen-Callbacks; kein Schlüssel.

Schema-Beispiel

"send"

Vollständiges Schema als JSON

{
  "type": "string",
  "description": "Status-/Ereignistyp des Pingen-Callbacks; kein Schlüssel.",
  "examples": [
    "send"
  ]
}

Query-Parameter

dataerforderlich

GET-Legacy-Alias erwartet verschachtelte Query-Parameter, etwa data[relationships][letter][data][id]; ein JSON-Body wird hier nicht gelesen.

object

relationships object erforderlich

letter object erforderlich

data object erforderlich

id string erforderlich

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "relationships": {
      "type": "object",
      "properties": {
        "letter": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                }
              },
              "additionalProperties": true,
              "required": [
                "id"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        }
      },
      "additionalProperties": true,
      "required": [
        "letter"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "relationships"
  ]
}

Beispiel

{
  "relationships": {
    "letter": {
      "data": {
        "id": "synthetic-external-letter-id"
      }
    }
  }
}

style: deepObject
explode: true

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.

200text/plain

Text OK nach Verarbeitung des Rückrufs.

`text/plain`

string

Vollständiges Schema als JSON

{
  "type": "string"
}

Beispiel

"OK"

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/controllers/V2.php:28coreV2()

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

false

x-edoobox-get-effect

"business-mutation"

x-edoobox-documentationReview

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

x-edoobox-source

{
  "file": "application/controllers/V2.php",
  "method": "coreV2",
  "line": 28
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "description": "No account-JWT resource permission levels are applied. Authentication requirements, if any, are defined by this route source-specific boundary and dedicated security scheme.",
  "checkedByDispatcher": false,
  "levels": []
}

Vollständige Operation als JSON

{
  "operationId": "get_v2_auth_webhook_pingen_token",
  "summary": "Pingen-Briefstatus und Kosten übernehmen",
  "description": "Empfängt einen Pingen-Rückruf. Das Pfadsegment token ist hier tatsächlich der Status-/Ereignistyp (z. B. send, error, not_deliverable), kein Authentifizierungstoken. data.relationships.letter.data.id identifiziert den externen Brief. Lädt dessen Status bei Pingen, aktualisiert lokalen Briefstatus und kann bei Rechnungen/Mahnungen Portokosten buchen. Der GET-Alias führt denselben schreibenden Handler aus; nicht als Leseabfrage verwenden. GET liest die verschachtelte Query-data-Struktur, POST den JSON-Body; ein GET-JSON-Body wird vom Dispatcher nicht übernommen.",
  "tags": [
    "auth"
  ],
  "security": [],
  "parameters": [
    {
      "name": "token",
      "in": "path",
      "required": true,
      "description": "Legacy-Name token im Pfad.",
      "schema": {
        "type": "string",
        "description": "Status-/Ereignistyp des Pingen-Callbacks; kein Schlüssel.",
        "examples": [
          "send"
        ]
      }
    },
    {
      "name": "data",
      "in": "query",
      "required": true,
      "style": "deepObject",
      "explode": true,
      "schema": {
        "type": "object",
        "properties": {
          "relationships": {
            "type": "object",
            "properties": {
              "letter": {
                "type": "object",
                "properties": {
                  "data": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "id"
                    ]
                  }
                },
                "additionalProperties": true,
                "required": [
                  "data"
                ]
              }
            },
            "additionalProperties": true,
            "required": [
              "letter"
            ]
          }
        },
        "additionalProperties": true,
        "required": [
          "relationships"
        ]
      },
      "example": {
        "relationships": {
          "letter": {
            "data": {
              "id": "synthetic-external-letter-id"
            }
          }
        }
      },
      "description": "GET-Legacy-Alias erwartet verschachtelte Query-Parameter, etwa data[relationships][letter][data][id]; ein JSON-Body wird hier nicht gelesen."
    }
  ],
  "responses": {
    "200": {
      "description": "Text OK nach Verarbeitung des Rückrufs.",
      "content": {
        "text/plain": {
          "schema": {
            "type": "string"
          },
          "example": "OK"
        }
      }
    },
    "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": true,
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "business-mutation",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/05-auth.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/controllers/V2.php",
    "method": "coreV2",
    "line": 28
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "description": "No account-JWT resource permission levels are applied. Authentication requirements, if any, are defined by this route source-specific boundary and dedicated security scheme.",
    "checkedByDispatcher": false,
    "levels": []
  }
}

Aufruf vorbereiten

Beispiel

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

cURL

# data: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
# cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${PATH_TOKEN:?PATH_TOKEN setzen}"
: "${QUERY_DATA:?QUERY_DATA setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/auth/webhook/pingen/'"${PATH_TOKEN}"'' \
  --url-query 'data='"${QUERY_DATA}"

JavaScript

// data: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/auth/webhook/pingen/{token}";
path = path.replaceAll("{token}", encodeURIComponent(required("PATH_TOKEN")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
url.searchParams.append("data", required("QUERY_DATA"));
const headers = {};
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

# data: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/auth/webhook/pingen/{token}"
path = path.replace("{token}", urllib.parse.quote(os.environ["PATH_TOKEN"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
url += "?" + urllib.parse.urlencode([("data", os.environ["QUERY_DATA"])])
headers = {}

# 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

// data: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/auth/webhook/pingen/{token}";
path = path.replaceAll("{token}", encodeURIComponent(required("PATH_TOKEN")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
url.searchParams.append("data", required("QUERY_DATA"));
const headers = {};
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

# data: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/auth/webhook/pingen/{token}"
path = path.replace("{token}", urllib.parse.quote(os.environ["PATH_TOKEN"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
url += "?" + urllib.parse.urlencode([("data", os.environ["QUERY_DATA"])])
headers = {}

# 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.