Espacio de trabajo · Documentación de TradeCatalog

Espacio de trabajo

Compruebe a qué espacio de trabajo pertenece una clave, y lea su moneda, zona horaria, país y terminología fiscal.

Obtener el espacio de trabajoEnlace a esta sección#

GET/api/v1/workspace

Devuelve el espacio de trabajo al que pertenece la clave, además del nombre y el alcance de la clave. Llámelo una vez cuando comience su integración, para verificar la clave y obtener la moneda.

Sin parámetros.

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	Descripción
`id`	string	El identificador del espacio de trabajo.
`slug`	string	La dirección del espacio de trabajo. El portal comercial está en `https://tradecatalog.app/p/{slug}`.
`name`	string	El nombre por el que los clientes conocen el negocio.
`currency`	string	Código ISO 4217. Todos los precios están en unidades menores de esta moneda.
`timezone`	string	Zona horaria IANA, por ejemplo `Europe/London`. Las fechas en la API son en UTC.
`country`	string	Código de país ISO 3166, por ejemplo `GB`. Cómo el proveedor escribe los precios y las fechas.
`taxLabel`	string	Mostrado junto a los precios: "ex IVA" (antes del impuesto), "incl. IVA" (incluyendo impuesto), o vacío.
`key.name`	string	El nombre que el propietario dio a esta clave.
`key.scope`	string	`read` o `write`.