PDF ACCESS CLOUD / Documentação

Documentação

Tudo para disponibilizar uma aplicação HTTP local.

Início rápido

Antes de começar

Precisa de Node.js 22.13 ou posterior e de uma aplicação HTTP local em execução. Crie uma conta e um túnel no painel. Guarde o token do conector quando aparecer; não pode ser recuperado depois.

Criar túnel

Mantenha o token privado

Defina PAC_CONNECTOR_TOKEN no terminal e execute o conector descarregado. O token é diferente de uma chave API e pertence a um só túnel. Renove-o no painel se o perder ou expuser.

Descarregar conector ↓

# Set the token returned when you create a tunnel
read -rs PAC_CONNECTOR_TOKEN
export PAC_CONNECTOR_TOKEN
node connect.mjs --port 3000

# Set the token returned when you create a tunnel
$secureToken = Read-Host 'Connector token' -AsSecureString
$env:PAC_CONNECTOR_TOKEN = [Net.NetworkCredential]::new('', $secureToken).Password
node connect.mjs --port 3000

Referência API

Crie uma chave API no painel e envie-a no cabeçalho Authorization. As chaves API gerem os túneis e chaves da sua conta; proteja-as como uma palavra-passe. Os tokens de conector são usados apenas pelo conector.

curl https://pdf-access-cloud.com/api/tunnels \
  -H "Authorization: Bearer $PAC_API_KEY"

Método	Rota	Função
`GET`	`/api/tunnels`	Listar túneis
`POST`	`/api/tunnels`	Criar túnel; mostrar token uma vez
`DELETE`	`/api/tunnels/:id`	Eliminar e desligar um túnel
`POST`	`/api/tunnels/:id/token`	Renovar token do conector
`GET`	`/api/keys`	Listar metadados de chaves
`POST`	`/api/keys`	Criar chave API; mostrar uma vez
`DELETE`	`/api/keys/:id`	Revogar chave API

POST /api/tunnels
Content-Type: application/json

{"name": "my-preview"}

201 Created
{
  "tunnel": {
    "id": "…",
    "name": "my-preview",
    "slug": "…",
    "url": "https://….tunnel.pdf-access-cloud.com",
    "status": "offline",
    "requests": 0
  },
  "connectorToken": "…"
}

Erros

Os erros são devolvidos em JSON. 401: credenciais ausentes ou inválidas; 403: acesso proibido; 404: recurso indisponível; 409: conflito de conta; 429: limite atingido. Túneis desligados devolvem 503.

OpenAPI 3.1 JSON

Âmbito e limites

A beta encaminha pedidos e respostas HTTP. Não encaminha WebSockets de aplicações, TCP/UDP arbitrário ou respostas em streaming. Os pedidos estão limitados a 2 MiB, as respostas a 4 MiB e o tempo de espera a 30 segundos. O conector deve permanecer ativo.

Até 5 túneis e 10 chaves API por conta. Corpos de pedidos limitados a 2 MiB, respostas a 4 MiB e tempo de espera a 30 segundos. Aplicações WebSocket e respostas em streaming não são suportadas.