Desarrolladores

Documentos

Descarga de documentos de la plataforma por identificador.

GET /documents/{id}/download

Descargar un documento

Devuelve el fichero original de un documento de la plataforma (URL permanente). El documento tiene que ser de tu cuenta.

Permiso exigido: documents:files.read (Documentos › Archivos › Leer)

Paginación: Sin paginación: devuelve el conjunto completo.

Parámetros

NombreEnTipoDescripción
idobligatoriorutastring

Respuestas

200 El fichero del documento · application/octet-stream

401 Falta el token Bearer o no es válido. · application/json

NombreTipoDescripción
errorstringMensaje de error legible
required_permissionstringSolo en el 403: el permiso que falta (área:recurso.acción)

403 El token no tiene el permiso exigido o el recurso queda fuera de su alcance. · application/json

NombreTipoDescripción
errorstringMensaje de error legible
required_permissionstringSolo en el 403: el permiso que falta (área:recurso.acción)

404 El recurso no existe o queda fuera del alcance del token. · application/json

NombreTipoDescripción
errorstringMensaje de error legible
required_permissionstringSolo en el 403: el permiso que falta (área:recurso.acción)

429 Se ha alcanzado un límite de uso. · application/json

NombreTipoDescripción
errorstringMensaje de error legible
required_permissionstringSolo en el 403: el permiso que falta (área:recurso.acción)

Ejemplos

curl 
curl -X GET "https://app.bm.consulting/api/v1/documents/<id>/download" \
  -H "Authorization: Bearer $BMC_TOKEN" \
  -o fichero
TypeScript (fetch) 
const res = await fetch("https://app.bm.consulting/api/v1/documents/<id>/download", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.BMC_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const file = Buffer.from(await res.arrayBuffer());
Python (requests) 
import os
import requests

res = requests.get(
    "https://app.bm.consulting/api/v1/documents/<id>/download",
    headers={"Authorization": f"Bearer {os.environ['BMC_TOKEN']}"},
    timeout=30,
)
res.raise_for_status()
contenido = res.content
Email
Contacto