Organización
Organización
Empresa dueña de la API key y cómo autenticar las peticiones.
Esta sección describe la empresa de la clave y los recursos de /org-api/v1: paquetes, recibos, clientes, contactos, estados y offices. El SDK @traky-app/sdk llama a estos recursos. La base es {BASE_URL}/org-api/v1. Los paquetes de un marketplace, como Misiil, están en Marketplace.
Autenticación
Envía la clave en uno de estos headers. No uses la sesión del panel.
Headers
| Atributo | Tipo | Descripción |
|---|---|---|
| Authorization | string | Bearer {API_KEY}. Forma recomendada. |
| X-Api-Key | string | La misma clave, si no usas Authorization. |
| Accept | string | application/json. |
curl -sS -H "Authorization: Bearer TU_API_KEY" \
"{BASE_URL}/org-api/v1/organization"Errores
| Código | Cuándo |
|---|---|
| 401 | Falta la clave, está revocada o no tiene empresa. |
| 403 | La clave no tiene permiso para ese recurso. |
{
"statusCode": 401,
"message": "Se requiere API key de la organización (Authorization: Bearer …)",
"error": "Unauthorized"
}Request
GET /org-api/v1/organizationPermiso: organization:read, packages:read o la clave de sistema de la organización.
Atributos
| Atributo | Tipo | Descripción |
|---|---|---|
| id | string | UUID de la empresa. |
| name | string | Nombre comercial. |
| slug | string | Identificador en la URL del courier. |
| enterpriseCode | string | Código interno de la empresa. |
| countryCode | string | País ISO, por ejemplo EC. |
| currency | string | Moneda, por ejemplo USD. |
| organizationId | string | Id de la organización en autenticación. |
JSON de retorno
{
"id": "8f1c2a40-1b2e-4d3a-9c10-6a7b8c9d0e1f",
"name": "Courier Andino",
"slug": "courier-andino",
"enterpriseCode": "CA-001",
"countryCode": "EC",
"currency": "USD",
"organizationId": "org_01HZXMPLACE"
}