Werkruimte · TradeCatalog documentatie

Werkruimte

Controleer welke werkruimte een sleutel behoort tot, en lees de valuta, tijdzone, land en belastingtermen van de werkruimte.

Werkruimte ophalenLink naar deze sectie#

GET/api/v1/workspace

Geeft de werkruimte terug waar de sleutel toe behoort, plus de naam en het bereik van de sleutel zelf. Roep het aan bij het starten van je integratie, om de sleutel te controleren en de valuta op te halen.

Geen parameters.

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" }
  }
}

Veld	Type	Beschrijving
`id`	string	De werkruimte id.
`slug`	string	De werkruimte adres. De handel portal is te vinden op `https://tradecatalog.app/p/{slug}`.
`name`	string	De naam waarmee klanten het bedrijf kennen.
`currency`	string	ISO 4217 code. Elke prijs is in mindere eenheden van deze valuta.
`timezone`	string	IANA tijdzone, bijv. `Europe/London`. Datums in de API zijn UTC.
`country`	string	ISO 3166 landcode, bijv. `GB`. Hoe de leverancier prijzen en datums schrijft.
`taxLabel`	string	Weergegeven naast prijzen: “ex BTW” (voor belasting), “inclusief BTW” (inclusief belasting), of leeg.
`key.name`	string	De naam die de eigenaar aan deze sleutel heeft gegeven.
`key.scope`	string	`read` of `write`.