GET/v2/accounting/bexio/callback

Bexio-Browserrückkehr verarbeiten

Öffentlicher OAuth-Callback für den Browser. Validiert den gespeicherten state, verarbeitet code oder error und aktiviert die Verbindung beziehungsweise verwirft den Zustand bei Abbruch/Fehler. Leitet mit result=success, cancelled oder failed zur konfigurierten Buchhaltungsoberfläche weiter; code und state werden nicht weitergereicht. Ungültige Frontend-Konfiguration kann vor einer Weiterleitung scheitern.

Operation-ID get_v2_accounting_bexio_callback

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.

Ressource: accounting · acco
Levels: Keine Account-Level angegeben
Dispatcher-Prüfung: Nein

Parameter

Query-Parameter

codeoptional

string

Schema-Beispiel

"opaque-oauth-code"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "opaque-oauth-code"
  ]
}

stateerforderlich

string

Schema-Beispiel

"opaque-oauth-state"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "opaque-oauth-state"
  ]
}

erroroptional

string

Schema-Beispiel

"opaque-oauth-error"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "opaque-oauth-error"
  ]
}

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.

200Ohne dokumentierten Response Body

HTTP 303 mit Location zur konfigurierten Oberfläche; vorhandene Fehlerantworten bleiben gültig.

303Ohne dokumentierten Response Body

When a valid accounting frontend base URI is configured, redirects to that configured UI result URL; OAuth code/state are not forwarded. This is a configuration-dependent browser response.

Response Header

502application/json

Public server-error envelope when callback setup fails, including a missing or invalid accounting frontend base URI. Configuration is loaded before the callback local try/catch. No token exchange is required to reach this configuration failure; no configuration values or provider credentials are returned. Additional generic development error references may be present.

`application/json`

object

success Typ nicht eingeschränkt

Fester Wert: false

error Typ nicht eingeschränkt

Fester Wert: "ED50201"

error_code string

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "const": false
    },
    "error": {
      "const": "ED50201"
    },
    "error_code": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

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

Quelle & Metadaten

Quelle laut Spezifikationapplication/controllers/V2.php:485handlePublicAccountingOAuthCallback()

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-auth-boundarySource

{
  "file": "application/models/v2/Accounting.php",
  "line": 50,
  "reason": "Loads AccountingOAuthRedirect::fromEnvironment before the local try block; missing/invalid frontend configuration reaches the central ED50201 envelope. A configured redirect retains HTTP303."
}

x-edoobox-runtimeMutationGuard

true

x-edoobox-get-effect

"business-mutation"

x-edoobox-documentationReview

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

x-edoobox-source

{
  "file": "application/controllers/V2.php",
  "method": "handlePublicAccountingOAuthCallback",
  "line": 485
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "accounting",
  "short": "acco",
  "checkedByDispatcher": false,
  "levels": [],
  "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."
}

Vollständige Operation als JSON

{
  "operationId": "get_v2_accounting_bexio_callback",
  "summary": "Bexio-Browserrückkehr verarbeiten",
  "description": "Öffentlicher OAuth-Callback für den Browser. Validiert den gespeicherten state, verarbeitet code oder error und aktiviert die Verbindung beziehungsweise verwirft den Zustand bei Abbruch/Fehler. Leitet mit result=success, cancelled oder failed zur konfigurierten Buchhaltungsoberfläche weiter; code und state werden nicht weitergereicht. Ungültige Frontend-Konfiguration kann vor einer Weiterleitung scheitern.",
  "tags": [
    "accounting"
  ],
  "security": [],
  "parameters": [
    {
      "name": "code",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "examples": [
          "opaque-oauth-code"
        ]
      }
    },
    {
      "name": "state",
      "in": "query",
      "required": true,
      "schema": {
        "type": "string",
        "examples": [
          "opaque-oauth-state"
        ]
      }
    },
    {
      "name": "error",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "examples": [
          "opaque-oauth-error"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "HTTP 303 mit Location zur konfigurierten Oberfläche; vorhandene Fehlerantworten bleiben gültig."
    },
    "303": {
      "description": "When a valid accounting frontend base URI is configured, redirects to that configured UI result URL; OAuth code/state are not forwarded. This is a configuration-dependent browser response.",
      "headers": {
        "Location": {
          "schema": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    },
    "502": {
      "description": "Public server-error envelope when callback setup fails, including a missing or invalid accounting frontend base URI. Configuration is loaded before the callback local try/catch. No token exchange is required to reach this configuration failure; no configuration values or provider credentials are returned. Additional generic development error references may be present.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "const": false
              },
              "error": {
                "const": "ED50201"
              },
              "error_code": {
                "type": "string"
              }
            },
            "additionalProperties": true
          },
          "example": {
            "error": "ED50201",
            "success": false
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "x-edoobox-auth-boundarySource": {
    "file": "application/models/v2/Accounting.php",
    "line": 50,
    "reason": "Loads AccountingOAuthRedirect::fromEnvironment before the local try block; missing/invalid frontend configuration reaches the central ED50201 envelope. A configured redirect retains HTTP303."
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-get-effect": "business-mutation",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/04-accounting.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/controllers/V2.php",
    "method": "handlePublicAccountingOAuthCallback",
    "line": 485
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "accounting",
    "short": "acco",
    "checkedByDispatcher": false,
    "levels": [],
    "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."
  }
}

Aufruf vorbereiten

Beispiel

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

cURL

: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${QUERY_STATE:?QUERY_STATE setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/accounting/bexio/callback' \
  --url-query 'state='"${QUERY_STATE}"

JavaScript

const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/accounting/bexio/callback";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
url.searchParams.append("state", required("QUERY_STATE"));
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

import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/accounting/bexio/callback"
url = os.environ["API_ORIGIN"].rstrip("/") + path
url += "?" + urllib.parse.urlencode([("state", os.environ["QUERY_STATE"])])
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

const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/accounting/bexio/callback";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
url.searchParams.append("state", required("QUERY_STATE"));
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

import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/accounting/bexio/callback"
url = os.environ["API_ORIGIN"].rstrip("/") + path
url += "?" + urllib.parse.urlencode([("state", os.environ["QUERY_STATE"])])
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.