APL Scheduler

API pública e cliente Java

Objetivo

Ligar um consumidor ao contrato público instalado.

Exemplo prático

Com conta serviço web de teste liste empresas e leia com companyCode. No Eclipse adicione JAR ao Build Path e Java 17.

Dos dados ao resultado

  1. 1Licença
  2. 2Serviço web
  3. 3Token
  4. 4Pedido

Referência: `/api-docs`; contrato: `/openapi/v1.json`. Use a versão instalada para campos e operações.

  1. 1
    São necessários APL Integration e utilizador serviço web com empresas e funções. Peça token em `/api/v1/auth/service-token` e use Authorization Bearer.
  2. 2
    Escolha empresa por `companyCode`. O servidor valida acessos; não partilhe tokens entre clientes.
  3. 3
    Crie no Eclipse um projeto Java com `java-client/src` ou adicione o JAR ao Build Path. Use Java 17, sem bibliotecas externas.
  4. 4
    Assistant, Factory View, ajuda/suporte e Painel APL não são API pública. Não automatize endpoints internos nem publique segredos.

Referência técnica

Exemplo ilustrativo: adapte ao contrato instalado e use um cofre de segredos.

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();
OpenAPI ↗OpenAPI JSON ↗

Antes de terminar

OpenAPI corresponde ao servidor, licença, empresa e função válidas. Trate 401, 403, 409 e 429 sem repetir escritas cegamente.

Dúvidas frequentes

Falta opção ou não posso editar

Verifique empresa, licença, permissões e campos integrados. URL direto não ultrapassa restrições.

Não encontro registos

Limpe filtros e verifique página, datas e empresa. Pode não haver dados acessíveis; não crie duplicados.

Guardei sem o efeito esperado

Reabra e verifique. Guardar não publica uma simulação necessária. Verifique a primeira escrita antes de repetir.

Guias relacionados