PDF ACCESS CLOUD / Dokumentation

Dokumentation

Alles, um eine lokale HTTP-Anwendung online zu bringen.

Schnellstart

Vor dem Start

Sie benötigen Node.js 22.13 oder neuer und eine lokal laufende HTTP-App. Erstellen Sie ein Konto und einen Tunnel im Dashboard. Speichern Sie das Connector-Token sofort; es wird später nicht erneut angezeigt.

Tunnel erstellen

Connector-Token geheim halten

Setzen Sie PAC_CONNECTOR_TOKEN in Ihrer Shell und starten Sie den heruntergeladenen Connector. Dieses Token ist kein API-Schlüssel und gehört zu einem Tunnel. Erneuern Sie es im Dashboard, wenn es verloren geht oder offengelegt wurde.

Connector herunterladen ↓

# 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

API-Referenz

Erstellen Sie einen API-Schlüssel im Dashboard und senden Sie ihn im Authorization-Header. API-Schlüssel verwalten Tunnel und Schlüssel Ihres Kontos. Schützen Sie sie wie ein Passwort. Connector-Tokens werden nur vom Connector verwendet.

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

Methode	Endpunkt	Zweck
`GET`	`/api/tunnels`	Tunnel auflisten
`POST`	`/api/tunnels`	Tunnel erstellen; Token einmal anzeigen
`DELETE`	`/api/tunnels/:id`	Tunnel löschen und trennen
`POST`	`/api/tunnels/:id/token`	Connector-Token erneuern
`GET`	`/api/keys`	Schlüssel-Metadaten auflisten
`POST`	`/api/keys`	API-Schlüssel erstellen; einmal anzeigen
`DELETE`	`/api/keys/:id`	API-Schlüssel widerrufen

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": "…"
}

Fehler

Fehler werden als JSON ausgegeben. 401: fehlende oder ungültige Zugangsdaten; 403: Zugriff verweigert; 404: Ressource nicht verfügbar; 409: Kontokonflikt; 429: Limit erreicht. Getrennte Tunnel liefern 503.

OpenAPI 3.1 JSON

Umfang und Grenzen

Die Beta leitet HTTP-Anfragen und -Antworten weiter. Anwendungs-WebSockets, beliebiges TCP/UDP und Antwortstreams werden nicht unterstützt. Es gelten 2 MiB für Anfragen, 4 MiB für Antworten und 30 Sekunden Zeitlimit. Der Connector muss weiterlaufen.

Bis zu 5 Tunnel und 10 API-Schlüssel pro Konto. Anfragen sind auf 2 MiB, Antworten auf 4 MiB und die Dauer auf 30 Sekunden begrenzt. WebSocket-Apps und Streaming-Antworten werden noch nicht unterstützt.