Arbeitsbereich · TradeCatalog-Dokumentation

Arbeitsbereich

Überprüfen Sie, zu welchem Arbeitsbereich ein Schlüssel gehört, und lesen Sie Währung, Zeitzone, Land und Steuerausdrücke.

Arbeitsbereich abrufenLink zu diesem Abschnitt#

GET/api/v1/workspace

Gibt den Arbeitsbereich zurück, zu dem der Schlüssel gehört, plus den Namen und den Umfang des Schlüssels. Rufen Sie es einmal auf, wenn Ihre Integration startet, um den Schlüssel zu prüfen und die Währung abzuholen.

Keine Parameter.

bash

curl https://tradecatalog.app/api/v1/workspace \
  -H "Authorization: Bearer $TRADECATALOG_API_KEY"

const res = await fetch('https://tradecatalog.app/api/v1/workspace', {
  headers: { Authorization: `Bearer ${process.env.TRADECATALOG_API_KEY}` },
})
const { data: workspace } = await res.json()

json

{
  "data": {
    "id": "0b6c1f5e-6f7a-4a57-9a0c-2f4d4c1e8a11",
    "slug": "northgate",
    "name": "Northgate Fixings",
    "currency": "GBP",
    "timezone": "Europe/London",
    "country": "GB",
    "taxLabel": "ex VAT",
    "key": { "name": "Sage stock sync", "scope": "write" }
  }
}

Feld	Typ	Beschreibung
`id`	string	Die Arbeitsbereich-ID.
`slug`	string	Die Arbeitsbereich-Adresse. Der Handelsservice ist unter `https://tradecatalog.app/p/{slug}`.
`name`	string	Der Name, unter dem das Unternehmen bekannt ist.
`currency`	string	ISO 4217-Code. Jeder Preis ist in Einheiten dieser Währung.
`timezone`	string	IANA-Zeitzone, z. B. `Europe/London`. Daten in der API sind UTC.
`country`	string	ISO 3166-Ländercode, z. B. `GB`. Wie der Lieferant Preise und Daten schreibt.
`taxLabel`	string	Angezeigt neben Preisen: „ex MwSt.“ (vor Steuern), „inkl. MWSt.“ (inkl. Steuern) oder leer.
`key.name`	string	Der Name, den der Besitzer diesem Schlüssel gegeben hat.
`key.scope`	string	`read` oder `write`.