Skip to content

API referenca

Potpuna API dokumentacija za Visiono REST API.

API dokumentacija

Potpuna API dokumentacija

Interaktivna API dokumentacija s primjerima, shemama zahtjeva/odgovora i alatima za testiranje.

Otvori API dokumentaciju →

Brzi linkovi

ResursOpis
API dokumentacijaPotpuna interaktivna API referenca
API ključeviKreirajte i upravljajte API ključevima
WebhooksPostavite obavijesti o događajima

Pregled API-ja

Bazni URL

https://api.visio.now/v1

Autentifikacija

Svi API zahtjevi zahtijevaju autentifikaciju putem API ključa:

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

Format odgovora

Svi odgovori su u JSON formatu:

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

Dostupne krajnje točke

Zahtjevi za fotografije

MetodaKrajnja točkaOpis
GET/photo-requestsPopis svih zahtjeva za fotografije
POST/photo-requestsKreiraj novi zahtjev za fotografije *
GET/photo-requests/{id}Dohvati određeni zahtjev
DELETE/photo-requests/{id}Obriši zahtjev

* Korisnici besplatnog plana ne mogu koristiti parametre recipient_email ili send_email. Pogledajte ograničenja besplatnog plana.

Statistike

MetodaKrajnja točkaOpis
GET/statsDohvati statistike korištenja i info plana

Trajni linkovi

MetodaKrajnja točkaOpis
GET/permanent-linksPopis svih Trajnih linkova
POST/permanent-linksKreiraj novi Trajni link
GET/permanent-links/{id}Dohvati određeni Trajni link
PATCH/permanent-links/{id}Ažuriraj Trajni link
DELETE/permanent-links/{id}Obriši Trajni link

Status

MetodaKrajnja točkaOpis
GET/statusProvjera zdravlja API-ja

Odgovori na greške

Format greške

json
{
  "error": {
    "code": "validation_error",
    "message": "Dani podaci nisu valjani.",
    "details": {
      "instructions": ["Polje upute je obavezno."]
    }
  }
}

Uobičajeni statusni kodovi

KodOpis
200Uspjeh
201Kreirano
400Loš zahtjev
401Neautoriziran
403Zabranjeno
404Nije pronađeno
422Greška validacije
429Ograničenje brzine
500Greška poslužitelja

Ograničenja brzine

OgraničenjeVrijednost
Zahtjeva po minuti60
Zahtjeva po satu1.000

Zaglavlja ograničenja brzine:

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

SDK-ovi i biblioteke

Trenutno je API baziran na REST-u. Službeni SDK-ovi dolaze uskoro.

Alati zajednice

Za automatizaciju, razmotrite:

Ograničenja besplatnog plana

Developer Free Plan ima specifična API ograničenja:

Zabranjeni parametri e-pošte

Korisnici besplatnog plana dobivaju 422 greške pri korištenju:

  • recipient_email - Parametar adrese e-pošte
  • send_email - Boolean oznaka za slanje e-pošte

API odgovor greške:

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

Alternativa: Koristite request_url iz uspješnih odgovora za dijeljenje linkova putem drugih kanala (SMS, chat itd.).

Razlike u Stats odgovoru

GET /stats odgovori besplatnog plana uključuju:

  • plan.email_enabled: false
  • usage.is_lifetime_quota: true (100 fotografija ukupno, ne mjesečno)
  • usage.billing_period_start: null
  • usage.billing_period_end: null

Pogledajte detaljnu dokumentaciju besplatnog plana

Podrška

Trebate pomoć s API-jem?

Povezane stranice

Profesionalna Platforma za Foto Dokumentaciju