Hiter začetek za razvijalce
Ustvarite svojo prvo foto zahtevo prek API v 5 minutah.
Predpogoji
Preden začnete, se prepričajte, da imate:
- Aktiven Visiono račun z dostopom do API
- Ustvarjen API ključ
- Pripravljen webhook naslov (ali uporabite webhook.site za testiranje)
Korak 1: Ustvarite foto zahtevo
Uporabite API za ustvarjanje enkratne foto zahteve:
curl -X POST "https://www.visiono.iohttps://www.visiono.io/si/docs/api/v1/photo-requests" \
-H "X-API-Key: vsk_live_vas_api_kljuc_tukaj" \
-H "Content-Type: application/json" \
-d '{
"instructions": "Prosimo, fotografirajte paket z vseh strani",
"expires_in_hours": 24
}'Pričakovan odgovor
{
"data": {
"id": "req_abc123",
"unique_code": "ABC123",
"status": "pending",
"instructions": "Prosimo, fotografirajte paket z vseh strani",
"request_url": "https://visio.now/p/abc123",
"code_entry_url": "https://visio.now/code",
"expires_at": "2024-01-16T10:00:00Z",
"created_at": "2024-01-15T10:00:00Z",
"items": []
}
}Ključna polja v odgovoru:
| Polje | Opis |
|---|---|
id | Edinstveni identifikator zahteve |
request_url | Delite to povezavo s svojo stranko |
unique_code | Kratka koda za ročni vnos na code_entry_url |
expires_at | Kdaj zahteva poteče |
Korak 2: Delite povezavo
Pošljite request_url iz odgovora svoji stranki prek SMS, e-pošte ali katerega koli kanala za sporočanje.
Ko stranka odpre povezavo:
- Vidi vaša navodila
- Aktivira se kamera (brez dostopa do galerije)
- Posname zahtevane fotografije
- Fotografije so oddane v vaš delovni prostor
Samo kamera
Stranke lahko uporabljajo samo kamero svoje naprave — brez nalaganja iz galerije. To zagotavlja pristne fotografije v realnem času.
Korak 3: Prejmite webhook
Ko so fotografije oddane, Visiono pošlje webhook na vaš konfigurirani naslov.
Nastavite svoj webhook handler
Ustvarite preprost Express strežnik za prejemanje webhookov:
const express = require('express');
const crypto = require('crypto');
const app = express();
app.use(express.json());
const WEBHOOK_SECRET = process.env.WEBHOOK_SECRET;
app.post('/webhook', (req, res) => {
// 1. Preverite podpis
const signature = req.headers['x-webhook-signature'];
const payload = JSON.stringify(req.body);
const expected = 'sha256=' + crypto
.createHmac('sha256', WEBHOOK_SECRET)
.update(payload)
.digest('hex');
if (!crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(signature))) {
console.error('Neveljaven webhook podpis');
return res.status(401).send('Neveljaven podpis');
}
// 2. Takoj potrdite prejem
res.status(200).send('OK');
// 3. Obdelajte dogodek
const { event, data } = req.body;
if (event === 'photo_request.submitted') {
console.log('ID zahteve:', data.id);
console.log('Prejete fotografije:');
data.photos.forEach((photo, index) => {
console.log(` ${index + 1}. ${photo.url}`);
if (photo.metadata?.gps_lat) {
console.log(` GPS: ${photo.metadata.gps_lat}, ${photo.metadata.gps_lng}`);
}
});
}
});
app.listen(3000, () => {
console.log('Webhook strežnik teče na portu 3000');
});Primer webhook vsebine
{
"event": "photo_request.submitted",
"timestamp": "2024-01-15T10:30:00Z",
"data": {
"id": "req_abc123",
"type": "one_time",
"instructions": "Prosimo, fotografirajte paket z vseh strani",
"photos": [
{
"id": "photo_xyz789",
"url": "https://storage.visiono.io/photos/xyz789.jpg",
"metadata": {
"gps_lat": 45.4642,
"gps_lng": 9.1900,
"captured_at": "2024-01-15T10:28:00Z"
}
}
],
"submitted_at": "2024-01-15T10:30:00Z"
}
}Testiranje webhookov
Uporabite webhook.site, da dobite začasen naslov za testiranje. Vidite lahko dohodne vsebine v realnem času brez nastavitve strežnika.
Korak 4: Prenesite fotografije
URL-ji fotografij v webhook vsebini so neposredne povezave za prenos:
# Prenos fotografije
curl -O "https://storage.visiono.io/photos/xyz789.jpg"Ali programatično v vašem webhook handlerju:
const https = require('https');
const fs = require('fs');
function downloadPhoto(url, filename) {
const file = fs.createWriteStream(filename);
https.get(url, (response) => {
response.pipe(file);
file.on('finish', () => file.close());
});
}
// V vašem webhook handlerju
data.photos.forEach((photo, index) => {
downloadPhoto(photo.url, `photo_${index + 1}.jpg`);
});Preizkusite svojo nastavitev
Uporabite ta kontrolni seznam za preverjanje, da vse deluje:
| Preizkus | Kako preveriti |
|---|---|
| API ključ deluje | GET https://www.visiono.io/si/docs/api/v1/ping vrne 200 OK |
| Zahteva ustvarjena | Odgovor vsebuje request_url in unique_code |
| Povezava dostopna | Odprite request_url v brskalniku, kamera se aktivira |
| Webhook konfiguriran | Ustvarite webhook na nadzorni plošči |
| Webhook prejema | Testni dogodek prispe na vaš naslov |
| Podpis veljaven | Handler vrne 200, ne 401 |
Hiter API preizkus
# Preizkusite svoj API ključ
curl -X GET "https://www.visiono.iohttps://www.visiono.io/si/docs/api/v1/ping" \
-H "X-API-Key: vsk_live_vas_api_kljuc_tukaj"Pričakovan odgovor:
{
"message": "pong",
"timestamp": "2024-01-15T10:00:00Z"
}Naslednji koraki
Zdaj, ko imate osnove delujoče:
- Webhooks — Konfigurirajte vse razpoložljive dogodke
- Trajne povezave — Ustvarite ponovno uporabne povezave za neprekinjeno zbiranje
- Foto reže — Zahtevajte specifične fotografije z navodili
- API referenca — Celotna dokumentacija končnih točk
Potrebujete pomoč? Preverite API referenco za podrobno dokumentacijo končnih točk ali konfigurirajte Webhooks za vse razpoložljive dogodke.
