Spazio di lavoro · documentazione TradeCatalog

Spazio di lavoro

Controlla a quale spazio di lavoro appartiene una chiave e leggi la sua valuta, fuso orario, paese e terminologia fiscale.

Ottieni lo spazio di lavoroCollegamento a questa sezione#

GET/api/v1/workspace

Restituisce lo spazio di lavoro a cui appartiene la chiave, insieme al nome e allo scope della chiave stessa. Chiamalo una volta all'inizio della tua integrazione, per verificare la chiave e raccogliere la valuta.

Nessun parametro.

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

Campo	Tipo	Descrizione
`id`	string	L'ID del workspace.
`slug`	string	L'indirizzo del workspace. Il portale commerciale si trova su `https://tradecatalog.app/p/{slug}`.
`name`	string	Il nome con cui i clienti conoscono l'azienda.
`currency`	string	Codice ISO 4217. Ogni prezzo è espresso in unità minori di questa valuta.
`timezone`	string	Fuso orario IANA, ad esempio `Europe/London`. Le date nell'API sono in UTC.
`country`	string	Codice paese ISO 3166, ad esempio `GB`. Come il fornitore scrive prezzi e date.
`taxLabel`	string	Visualizzato accanto ai prezzi: "escl. IVA" (prima dell'imposta), "incl. IVA" (inclusa l'imposta), o vuoto.
`key.name`	string	Il nome che il proprietario ha dato a questa chiave.
`key.scope`	string	`read` o `write`.