Skip to content

API-Referenz

Vollständige API-Dokumentation für die Visiono REST API.

API-Dokumentation

Vollständige API-Dokumentation

Interaktive API-Dokumentation mit Beispielen, Anfrage-/Antwort-Schemata und Test-Tools.

API-Dokumentation öffnen →
RessourceBeschreibung
API-DokumentationVollständige interaktive API-Referenz
API-SchlüsselAPI-Schlüssel erstellen und verwalten
WebhooksEreignisbenachrichtigungen einrichten

API-Überblick

Basis-URL

https://api.visio.now/v1

Authentifizierung

Alle API-Anfragen erfordern Authentifizierung per API-Schlüssel:

bash
curl -X GET "https://api.visio.now/v1/status" \
  -H "X-API-Key: ihr-api-schluessel"

Antwortformat

Alle Antworten sind JSON:

json
{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123"
  }
}

Verfügbare Endpunkte

Fotoanfragen

MethodeEndpunktBeschreibung
GET/photo-requestsAlle Fotoanfragen auflisten
POST/photo-requestsNeue Fotoanfrage erstellen *
GET/photo-requests/{id}Bestimmte Anfrage abrufen
DELETE/photo-requests/{id}Anfrage löschen

* Free-Plan-Benutzer können die Parameter recipient_email oder send_email nicht verwenden. Siehe Free-Plan Einschränkungen.

Statistiken

MethodeEndpunktBeschreibung
GET/statsNutzungsstatistiken und Plan-Info abrufen
MethodeEndpunktBeschreibung
GET/permanent-linksAlle Permanenten Links auflisten
POST/permanent-linksNeuen Permanenten Link erstellen
GET/permanent-links/{id}Bestimmten Permanenten Link abrufen
PATCH/permanent-links/{id}Permanenten Link aktualisieren
DELETE/permanent-links/{id}Permanenten Link löschen

Status

MethodeEndpunktBeschreibung
GET/statusAPI-Gesundheitsprüfung

Fehlerantworten

Fehlerformat

json
{
  "error": {
    "code": "validation_error",
    "message": "Die angegebenen Daten waren ungültig.",
    "details": {
      "instructions": ["Das Anweisungsfeld ist erforderlich."]
    }
  }
}

Häufige Statuscodes

CodeBeschreibung
200Erfolg
201Erstellt
400Fehlerhafte Anfrage
401Nicht autorisiert
403Verboten
404Nicht gefunden
422Validierungsfehler
429Rate-Limit überschritten
500Serverfehler

Rate-Limits

LimitWert
Anfragen pro Minute60
Anfragen pro Stunde1.000

Rate-Limit-Header:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1609459200

SDKs und Bibliotheken

Derzeit ist die API REST-basiert. Offizielle SDKs kommen bald.

Community-Tools

Für Automatisierung, erwägen Sie:

Free-Plan Einschränkungen

Der Developer Free Plan hat spezifische API-Einschränkungen:

E-Mail-Parameter verboten

Free-Plan-Benutzer erhalten 422-Fehler bei Verwendung von:

  • recipient_email - E-Mail-Adressparameter
  • send_email - Boolean-Flag zum Versenden von E-Mails

API-Fehlerantwort:

json
{
  "message": "The recipient email field is prohibited.",
  "errors": {
    "recipient_email": [
      "Email features are not available on the free plan. Upgrade to send photo requests via email."
    ]
  }
}

Workaround: Verwenden Sie die request_url aus erfolgreichen Antworten, um Links über andere Kanäle zu teilen (SMS, Chat, etc.).

Unterschiede bei Stats-Antwort

Free-Plan GET /stats Antworten enthalten:

  • plan.email_enabled: false
  • usage.is_lifetime_quota: true (100 Fotos insgesamt, nicht monatlich)
  • usage.billing_period_start: null
  • usage.billing_period_end: null

Siehe detaillierte Free-Plan-Dokumentation

Support

Brauchen Sie Hilfe mit der API?

Verwandte Seiten

Professionelle Plattform für Fotodokumentation