Herramientas

Todo sale del mismo OpenAPI que sirve esta página. Si la API cambia, estas piezas cambian con ella.

OpenAPI 3.1

El contrato completo, para generar un cliente en tu lenguaje o cargarlo en tu herramienta favorita.

Descargar openapi.json

Postman

Una colección con una carpeta por sección y una petición por operación, más un recorrido guiado de diez pasos que encadena los ids por variables. Importa la colección y un ambiente, pega tu llave en la variable key y corre la carpeta «00 · Recorrido guiado» con Run collection.

Descargar la colección

Bruno

La misma colección en formato Bruno (un archivo por operación) vive en el repositorio de la API, en api/bruno/, y se regenera con el OpenAPI vivo.

El cliente @datrus/api

Un fetch con tres reglas encima: la llave en Authorization, el Idempotency-Key en los POST que crean, y los errores ya separados como problem con su requestId. Los tipos salen del OpenAPI.

import { crearCliente, claveIdempotente } from '@datrus/api'

const datrus = crearCliente({ key: process.env.DATRUS_API_KEY })

const yo = await datrus.get('/me')
if (!yo.ok) throw new Error(`${yo.problem.title}: ${yo.problem.detail} (${yo.requestId})`)

const creado = await datrus.post('/tasks', { phase: 2, title: 'Cerrar el inventario' }, claveIdempotente('tsk'))

for await (const doc of datrus.todos('/documents', { limit: 100 })) console.log(doc.id, doc.key, doc.state)

Probar desde la referencia

La referencia tiene un cliente incorporado: pega tu llave en Authentication, elige el servidor y manda la petición desde el navegador. La llave se queda en tu navegador, no en nuestros servidores.