API referenca

Celotna API dokumentacija za Visiono REST API.

API dokumentacija

Celotna API dokumentacija

Interaktivna API dokumentacija s primeri, shemami zahtev/odgovorov in orodji za testiranje.

Odpri API dokumentacijo →

Hitre povezave

Vir	Opis
API dokumentacija	Celotna interaktivna API referenca
API ključi	Ustvarite in upravljajte API ključe
Webhooks	Nastavite obvestila o dogodkih

Pregled API

Osnovni URL

https://api.visio.now/v1

Avtentikacija

Vse API zahteve zahtevajo avtentikacijo prek API ključa:

curl -X GET "https://api.visio.now/v1/status" \
  -H "X-API-Key: vas-api-kljuc"

Format odgovora

Vsi odgovori so JSON:

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

Razpoložljive končne točke

Foto zahteve

Metoda	Končna točka	Opis
GET	/photo-requests	Seznam vseh foto zahtev
POST	/photo-requests	Ustvari novo foto zahtevo *
GET	/photo-requests/{id}	Pridobi določeno zahtevo
DELETE	/photo-requests/{id}	Izbriši zahtevo

* Uporabniki brezplačnega paketa ne morejo uporabljati parametrov recipient_email ali send_email. Glejte omejitve brezplačnega paketa.

Statistika

Metoda	Končna točka	Opis
GET	/stats	Pridobi statistiko uporabe in podatke o paketu

Trajne povezave

Metoda	Končna točka	Opis
GET	/permanent-links	Seznam vseh trajnih povezav
POST	/permanent-links	Ustvari novo trajno povezavo
GET	/permanent-links/{id}	Pridobi določeno trajno povezavo
PATCH	/permanent-links/{id}	Posodobi trajno povezavo
DELETE	/permanent-links/{id}	Izbriši trajno povezavo

Status

Metoda	Končna točka	Opis
GET	/status	Preverjanje zdravja API

Odgovori napak

Format napake

{
  "error": {
    "code": "validation_error",
    "message": "Podani podatki niso veljavni.",
    "details": {
      "instructions": ["Polje navodila je obvezno."]
    }
  }
}

Pogoste statusne kode

Koda	Opis
200	Uspeh
201	Ustvarjeno
400	Napačna zahteva
401	Nepooblaščeno
403	Prepovedano
404	Ni najdeno
422	Napaka validacije
429	Omejitev hitrosti
500	Napaka strežnika

Omejitve hitrosti

Omejitev	Vrednost
Zahtev na minuto	60
Zahtev na uro	1.000

Glave omejitve hitrosti:

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

SDK-ji in knjižnice

Trenutno je API zasnovan na REST. Uradni SDK-ji bodo kmalu na voljo.

Orodja skupnosti

Za avtomatizacijo razmislite o:

• Zapier integracija
• Make integracija
• n8n integracija

Omejitve brezplačnega paketa

Developer Free Plan ima posebne API omejitve:

Prepovedani e-poštni parametri

Uporabniki brezplačnega paketa prejmejo napake 422 pri uporabi:

• recipient_email - Parameter e-poštnega naslova
• send_email - Boolean oznaka za pošiljanje e-pošte

API odgovor napake:

{
  "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."
    ]
  }
}

Alternativa: Uporabite request_url iz uspešnih odgovorov za deljenje povezav prek drugih kanalov (SMS, klepet itd.).

Razlike v Stats odgovoru

GET /stats odgovori brezplačnega paketa vključujejo:

• plan.email_enabled: false
• usage.is_lifetime_quota: true (100 fotografij skupaj, ne mesečno)
• usage.billing_period_start: null
• usage.billing_period_end: null

Glejte podrobno dokumentacijo brezplačnega paketa

Podpora

Potrebujete pomoč z API?

• Preverite celotno API dokumentacijo
• Preglejte nastavitev API ključev
• Konfigurirajte Webhooks za posodobitve v realnem času
• Obrnite se na podporo za poslovne potrebe

Povezane strani

• API ključi - Nastavitev avtentikacije
• Webhooks - Obvestila o dogodkih
• Integracije - Integracije brez kode
• Omejitve uporabe - Podrobnosti o brezplačnem paketu