API für Entwickler

Panorise stellt eine einfache HTTP-API bereit, mit der eigene Integrationen auf Projekte, Bilder und Rendering-Jobs zugreifen können.

Authentifizierung

Senden Sie Ihr API Token im Header X-Api-Key.

curl -H "X-Api-Key: IHR_API_TOKEN" https://app.panorise.de/api/Pictures/user-images

Ein Website API Token kann nur auf Bilder der ausgewählten Website zugreifen. Ein globales API Token kann auf alle Bilder zugreifen, die Ihrem Konto zugeordnet sind.

Wenn Sie ein neues Token generieren, verliert das bisherige Token seine Gültigkeit.

Projekte abrufen

curl -H "X-Api-Key: IHR_API_TOKEN" https://app.panorise.de/api/Projects/user-projects

Die Antwort enthält die verfügbaren Websites mit ID, Name, Beschreibung und Zeitstempeln.

Bilder abrufen

Alle Bilder, auf die das Token Zugriff hat:

curl -H "X-Api-Key: IHR_API_TOKEN" https://app.panorise.de/api/Pictures/user-images

Bilder einer bestimmten Website:

curl -H "X-Api-Key: IHR_API_TOKEN" https://app.panorise.de/api/Projects/123/pictures

Ein einzelnes Bild:

curl -H "X-Api-Key: IHR_API_TOKEN" https://app.panorise.de/api/Pictures/user-image/456

Die Bildantwort enthält unter anderem id, fileName, imageUrl, panoramaUrl, projectId und createdAt.

Rendering-Jobs abrufen

curl -H "X-Api-Key: IHR_API_TOKEN" https://app.panorise.de/api/RenderingJobs/user-rendering-jobs

Die Antwort enthält laufende, abgeschlossene und fehlgeschlagene Rendering-Jobs.

Rendering starten

Mit diesem Aufruf starten Sie ein neues Rendering für ein Bild:

curl -X POST https://app.panorise.de/api/RenderingJobs/create \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: IHR_API_TOKEN" \
  -d "{\"pictureId\":456}"

Wenn für dieses Bild bereits ein Rendering läuft, wird kein weiterer Job gestartet.

oEmbed

Panorise stellt auch einen oEmbed-Endpunkt bereit:

curl "https://app.panorise.de/oembed?url=https%3A%2F%2Fapp.panorise.de%2F...%2Findex.html&format=json"

Verwenden Sie als url eine fertige panoramaUrl aus der Bilder- oder Rendering-Job-Antwort. Die Antwort enthält HTML für ein iFrame und Metadaten wie Provider, Titel, Breite und Höhe. Optional können maxwidth und maxheight angegeben werden.

Fehlercodes

  • 401 Unauthorized: Token fehlt, ist ungültig oder hat keinen Zugriff.
  • 404 Not Found: Bild oder Projekt wurde nicht gefunden.
  • 400 Bad Request: Die Anfrage konnte nicht verarbeitet werden, zum Beispiel bei einer ungültigen Bild-ID.
  • 501 Not Implemented: Das angeforderte oEmbed-Format wird nicht unterstützt.