APL Scheduler

API pública y cliente Java

Qué aprenderás

Conectar un consumidor autorizado al contrato público instalado.

Ejemplo práctico

Con un usuario Servicio web de prueba, consulta las empresas asignadas y realiza una lectura con companyCode. En Eclipse añade el JAR al Build Path y configura Java 17.

Del dato al resultado

  1. 1Licencia
  2. 2Servicio web
  3. 3Token
  4. 4Petición

La referencia técnica está en `/api-docs` y el contrato en `/openapi/v1.json`. Esta guía explica cómo empezar; utiliza el contrato de la versión instalada para conocer campos y operaciones.

  1. 1
    Necesitas APL Integration y un usuario Servicio web con empresas y roles asignados. Solicita el token mediante `/api/v1/auth/service-token`; las siguientes llamadas utilizan la cabecera Authorization con Bearer y el token recibido.
  2. 2
    Selecciona la empresa con `companyCode` según el contrato. El servidor comprueba empresas y permisos: nunca se cambia de configuración enviando un identificador de cliente ni se comparten tokens entre clientes.
  3. 3
    Para Java utiliza el cliente generado compatible con el contrato del servidor y su documentación incluida. En Eclipse crea un proyecto Java e incorpora los fuentes de `java-client/src`, o añade el JAR al Build Path de tu proyecto. Configura Java 17; el cliente utiliza bibliotecas estándar de Java, sin dependencias externas.
  4. 4
    La API pública no incluye APL Assistant, Factory View, ayuda/soporte ni el Panel APL. No intentes automatizar estos módulos mediante endpoints internos. No publiques tokens, contraseñas o ejemplos con datos de clientes.

Referencia técnica

Ejemplo ilustrativo: adapta los valores al contrato instalado y utiliza un almacén de secretos.

Java 17 / HTTP→Bearer · companyCode→APL Scheduler
GET /api/v1/companies
Authorization: Bearer <accessToken>

GET /api/v1/materials?companyCode=DEMO&section=articles&page=1&pageSize=25
Authorization: Bearer <accessToken>

// Java 17 · Eclipse: Java Build Path > Libraries
var client = new AplSchedulerClient(baseUrl);
client.authenticate(new ServiceCredentials(
    configuration, serviceUser, passwordFromSecretStore));
ApiResponse response = client.companies();

Antes de darlo por terminado

El contrato OpenAPI corresponde al servidor; el usuario tiene APL Integration, empresa y rol. Gestiona 401, 403, 409 y 429 sin reintentos ciegos de escrituras.

Dudas frecuentes

No aparece una opción o no puedo editar

Comprueba empresa activa, licencia, permisos y si el campo está gobernado por una integración. No uses una URL directa para intentar saltarte una restricción.

No encuentro registros

Limpia filtros, comprueba página, fechas y empresa. Si sigue vacío, puede no haber datos accesibles; no crees registros duplicados para probar.

He guardado, pero no veo el efecto esperado

Reabre el registro y comprueba el resultado. Si requiere simulación, guardar el dato no publica el plan. Antes de repetir una escritura, verifica si la primera quedó aplicada.