menu  icon Antwort

Die Antwort der API

Wenn Sie Anfragen an die belegFuchs API senden, erhalten Sie immer eine Antwort im JSON-Format. Die Antwort ist in der Regel immer vom selben Aufbau, egal welchen API-Endpunkt Sie anfragen. Das führt dazu, dass Sie neben den Daten auch immer Nebeninformationen erhalten, die Ihnen helfen, die Daten richtig zu interpretieren.

Aufbau der Antwort

FeldTypBeschreibung
errorString?Ein Fehlercode, der von Ihrem System interpretiert werden kann.
errorTextString?Die lesbare Beschreibung des Fehlers.
dataTypeStringDer Datentyp für das data-Feld. Kann folgende Werte haben: Object, List, Text, None
dataObject?, Array?, String?Die eigentlichen Daten, die der jeweilige API-Endpunkt zurückgibt.
pageCountInt?Die Anzahl der Seiten für das data-Feld, wenn dataType List ist.

Beispiel - Erfolgreiche Antwort

Das Beispiel zeigt eine mögliche Antwort des API-Endpunkts https://api.belegfuchs.de/v1/products.

{
    "error": null,
    "errorText": null,
    "dataType": "List",
    "data": [
        {
            "id": "1",
            "number": "1000",
            "userId": "1",
            "stock": null,
            "useStock": 0,
            "category": 0,
            "unit": 1,
            "description": "Testprodukt",
            "note": "",
            "purchasePrice": 294.12,
            "sellingPrice": 323.53,
            "purchaseTax": 19,
            "sellingTax": 19,
            "created": "2023-12-28T00:58:32"
        }
    ],
    "pageCount": 1
}

Beispiel - Fehlerhafte Antwort

Das Beispiel zeigt eine mögliche Antwort des API-Endpunkts https://api.belegfuchs.de/v1/products.

{
    "error": "invalid_api_key",
    "errorText": "Der API-Key ist ungültig.",
    "dataType": "None",
    "data": null,
    "pageCount": null
}