Clientes

La API se describe mediante un documento OpenAPI, así que puede generarse un cliente para ella en la mayoría de los lenguajes con un generador como Kiota, NSwag u OpenAPI Generator: consulte OpenAPI. Sin embargo, es HTTPS y JSON sin más, así que puede usarse con la misma facilidad con el cliente HTTP propio de cualquier lenguaje, como hacen los ejemplos de estas páginas.

Sea cual sea el lenguaje, toda solicitud lleva su clave en el encabezado X-API-KEY: consulte Uso de la clave de API.

Ejemplos

Cada ejemplo es un programa completo que realiza la misma tarea, para poder compararlos:

1. Lee su clave de API de la variable de entorno PIQ_API_KEY, y la dirección del servicio de PIQ_URL (https://saas.parametriq.co.uk si no está definida).
2. Enumera las variables etiquetadas de una plantilla (POST /inputs): un rectángulo de 400 × 300, con su longitud L y su anchura W etiquetadas.
3. Mide el dibujo con L 500 y W 250 (POST /measure): su anchura, su altura y su longitud de corte.
4. Exporta el dibujo como PDF (POST /export/pdf), lo guarda como box.pdf e imprime el encabezado X-PiQ-Warnings.
5. Opcionalmente, cuando PIQ_STORAGE indica uno de sus almacenamientos registrados, lee la plantilla desde ese almacenamiento (source) y guarda también el PDF en él (POST /save/pdf).

Una solicitud que no tiene éxito lo detiene: imprime el estado y la descripción del problema (su title, detail, y qué está mal en qué valor, a partir de errors), y termina con un código distinto de 0. Un 401 (una clave que no es correcta) no tiene descripción del problema, así que solo se imprime el estado.

Cada página contiene el programa para leerlo y un enlace para descargarlo.

• JavaScript: Node.js 18 o posterior, con su fetch integrado; sin paquetes.
• Python: Python 3, con requests.
• C#: .NET, con HttpClient y System.Net.Http.Json; un programa de consola de un solo archivo.
• Go: Go, solo con la biblioteca estándar.
• Java: Java 17 o posterior, con java.net.http; sin bibliotecas.
• PHP: PHP 8, con la extensión curl.
• Ruby: Ruby 3, con net/http de la biblioteca estándar.
• curl: un script de bash, con curl y jq.

Para ejecutar uno, establezca primero su clave en el entorno: export PIQ_API_KEY=XXXX-XXXX-XXXX-XXXXX en bash, o $env:PIQ_API_KEY = "XXXX-XXXX-XXXX-XXXXX" en PowerShell. Mantenga la clave fuera del propio programa.

La plantilla de cada ejemplo es la de API:

L=400,"Length"
W=300,"Width"
P1=[L,0]
P2=[L,W]
P3=[0,W]
POLYLINE @1,[P0,P1,P2,P3],TRUE,0

Consulte también: API, OpenAPI, Uso de la clave de API.