DEVSDESIGN — DEVELOPERS & DESIGN

API v1 · contrato 1.0.0

SDK y ejemplos

Clientes para JavaScript y PHP y ejemplos en otros lenguajes.

Puedes usar la API con cualquier cliente HTTP. Para JavaScript y PHP hay además clientes que se encargan de la autenticación, los reintentos y el manejo de errores.

Disponibilidad. Los SDK se entregan junto con el acceso a la API. Si aún no los tienes, solicítalos.

JavaScript

Cliente ESM para Node.js 18 o superior, sin dependencias.

Emitir y consultar
import { Client } from '@devsdesign/ecf';

const dd = new Client(process.env.DD_API_KEY);

const doc = await dd.documents.create(factura);
const estado = await dd.documents.status(doc.id);

const xml = await dd.documents.xml(doc.id);
const pdf = await dd.documents.pdf(doc.id, 'a4');

// Recorrer todas las páginas de un listado
for await (const item of dd.documents.listAll({ limit: 50 })) {
  console.log(item.id);
}

PHP

Emitir y consultar
use DevsDesign\Ecf\Client;

$client = new Client(getenv('DD_API_KEY'));

$doc = $client->documents->create($factura);
$estado = $client->documents->status($doc['id']);

$xml = $client->documents->xml($doc['id']);
$pdf = $client->documents->pdf($doc['id'], 'a4');

foreach ($client->documents->listAll(['limit' => 50]) as $item) {
    echo $item['id'], PHP_EOL;
}

Manejo de errores

Ambos SDK convierten las respuestas de error en excepciones con tipo propio, que incluyen el estado HTTP, el código y el request_id:

ExcepciónCuándo ocurre
AuthenticationError401: credencial ausente o inválida.
PermissionError403: la clave no tiene el permiso requerido.
NotFoundError404: el recurso no existe.
IdempotencyConflictError409: la clave de idempotencia se usó con otro cuerpo.
ValidationError422: incluye la lista errors con el detalle por campo.
RateLimitError429: se superó el límite de solicitudes.
ServerError5xx: fallo temporal del servicio.
NetworkErrorNo se pudo completar la conexión.

Qué no hacen los SDK

Los SDK no firman documentos ni calculan impuestos: esas tareas las realiza el servidor. Tampoco deben usarse en el navegador, porque expondrían tu API key.

Otros lenguajes

Para Python, C#, Java, Go u otros lenguajes, usa la API REST directamente. En Primeros pasos hay un ejemplo en Python, y la referencia describe cada operación.

¿Algo no está claro o falta en esta página? Escríbenos por el centro de soporte.