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
| Resurs | Opis |
|---|---|
| API dokumentacija | Potpuna interaktivna API referenca |
| API ključevi | Kreirajte i upravljajte API ključevima |
| Webhooks | Postavite obavijesti o događajima |
Pregled API-ja
Bazni URL
https://api.visio.now/v1Autentifikacija
Svi API zahtjevi zahtijevaju autentifikaciju putem API ključa:
curl -X GET "https://api.visio.now/v1/status" \
-H "X-API-Key: vas-api-kljuc"Format odgovora
Svi odgovori su u JSON formatu:
{
"data": { ... },
"meta": {
"request_id": "req_abc123"
}
}Dostupne krajnje točke
Zahtjevi za fotografije
| Metoda | Krajnja točka | Opis |
|---|---|---|
GET | /photo-requests | Popis svih zahtjeva za fotografije |
POST | /photo-requests | Kreiraj 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
| Metoda | Krajnja točka | Opis |
|---|---|---|
GET | /stats | Dohvati statistike korištenja i info plana |
Trajni linkovi
| Metoda | Krajnja točka | Opis |
|---|---|---|
GET | /permanent-links | Popis svih Trajnih linkova |
POST | /permanent-links | Kreiraj 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
| Metoda | Krajnja točka | Opis |
|---|---|---|
GET | /status | Provjera zdravlja API-ja |
Odgovori na greške
Format greške
{
"error": {
"code": "validation_error",
"message": "Dani podaci nisu valjani.",
"details": {
"instructions": ["Polje upute je obavezno."]
}
}
}Uobičajeni statusni kodovi
| Kod | Opis |
|---|---|
200 | Uspjeh |
201 | Kreirano |
400 | Loš zahtjev |
401 | Neautoriziran |
403 | Zabranjeno |
404 | Nije pronađeno |
422 | Greška validacije |
429 | Ograničenje brzine |
500 | Greška poslužitelja |
Ograničenja brzine
| Ograničenje | Vrijednost |
|---|---|
| Zahtjeva po minuti | 60 |
| Zahtjeva po satu | 1.000 |
Zaglavlja ograničenja brzine:
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1609459200SDK-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štesend_email- Boolean oznaka za slanje e-pošte
API odgovor greške:
{
"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: falseusage.is_lifetime_quota: true(100 fotografija ukupno, ne mjesečno)usage.billing_period_start: nullusage.billing_period_end: null
Pogledajte detaljnu dokumentaciju besplatnog plana
Podrška
Trebate pomoć s API-jem?
- Provjerite potpunu API dokumentaciju
- Pregledajte postavljanje API ključeva
- Konfigurirajte Webhooks za ažuriranja u stvarnom vremenu
- Kontaktirajte podršku za enterprise potrebe
Povezane stranice
- API ključevi - Postavljanje autentifikacije
- Webhooks - Obavijesti o događajima
- Integracije - Integracije bez koda
- Ograničenja korištenja - Detalji besplatnog plana
