Espace de travail · Documentation de TradeCatalog

Espace de travail

Vérifiez quel espace de travail appartient à une clé, et lisez sa devise, fuseau horaire, pays et formulation fiscale.

Obtenir l'espace de travailLien vers cette section#

GET/api/v1/workspace

Renvoie l'espace de travail auquel appartient la clé, ainsi que le nom et la portée de la clé. Appelez-le une seule fois lorsque votre intégration démarre, pour vérifier la clé et récupérer la devise.

Aucun paramètre.

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

Champ	Type	Description
`id`	chaîne	L'identifiant de l'espace de travail.
`slug`	chaîne	L'adresse de l'espace de travail. Le portail de commerce est à `https://tradecatalog.app/p/{slug}`.
`name`	chaîne	Le nom par lequel les clients connaissent l'entreprise.
`currency`	chaîne	Code ISO 4217. Tous les prix sont exprimés en unités mineures de cette devise.
`timezone`	chaîne	Fuseau horaire IANA, par exemple `Europe/London`. Les dates de l'API sont en UTC.
`country`	chaîne	Code ISO 3166, par exemple `GB`. Comment le fournisseur écrit les prix et les dates.
`taxLabel`	chaîne	Affiché à côté des prix : « hors TVA » (avant impôt), « incl. GST » (avec impôt), ou vide.
`key.name`	chaîne	Le nom que le propriétaire a donné à cette clé.
`key.scope`	chaîne	`read` ou `write`.