Piekļūstiet sava seifa saturam programmatiski ar zero-knowledge šifrēšanu.
API atslēgas, šifrēšanas režīmi un piekļuves ierobežojumi
Tag API v2 piedāvā divus atšķirīgus šifrēšanas režīmus. Izvēlieties atbilstošo atkarībā no jūsu drošības prasībām un integrācijas sarežģītības.
Maksimāla drošība
Divas atslēgas — serveris nekad neredz jūsu datus. Šifrēšana un atšifrēšana notiek tikai jūsu pusē.
DROŠĪBAS LĪMENIS
Vienkāršāka integrācija
Viena atslēga — serveris atšifrē datus pieprasījuma brīdī. Vienkāršāk integrēt, bet mazāk drošs.
DROŠĪBAS LĪMENIS
| Aspekts | Zero-Knowledge | Server-Managed |
|---|---|---|
| Atslēgu skaits | 2 (access + decrypt) | 1 (managed) |
| Atšifrēšana notiek | Klienta pusē | Serverī |
| Šifrēšana (rakstīšana) | Klienta pusē | Serverī |
| Serveris redz datus | Nekad | Pieprasījuma laikā |
| Integrācijas sarežģītība | Augstāka | Zemāka |
| MCP / Claude Desktop | ✓ Pilnībā | ✓ Vienkāršots |
| Ieteicams priekš | Sensitīvi dati, compliance | Ātra integrācija, prototipi |
Drošības kompromiss
Server-Managed režīmā jūsu dati tiek atšifrēti mūsu serverī pieprasījuma apstrādes laikā. Lai gan mēs izmantojam TLS un drošu infrastruktūru, šis režīms nav zero-knowledge. Sensitīviem datiem vienmēr izvēlieties Zero-Knowledge režīmu.
PRO funkcija
Autentificējieties izmantojot jebkuru pieejamo metodi (Google, Draugiem.lv, eID, vai e-pasta OTP).
Augšējā labajā stūrī noklikšķiniet uz sava profila ikonas un izvēlieties "Iestatījumi".
Iestatījumu modalajā logā atrodiet "Tag API v2 Atslēgas" cilni.
Izvēlieties starp "Zero-Knowledge" (2 atslēgas) vai "Server-Managed" (1 atslēga).
Iestatiet atļaujas, IP adreses un derīguma termiņu (skatīt sadaļu zemāk).
Noklikšķiniet "Izveidot" un nekavējoties saglabājiet atslēgas drošā vietā. Tās vairs netiks rādītas!
Katrai API atslēgai varat konfigurēt precīzus ierobežojumus, lai nodrošinātu minimālo nepieciešamo piekļuvi.
Kontrolējiet, kādas darbības atslēga var veikt
vault:readLasīt seifa informāciju
items:readLasīt vienumu sarakstu un saturu
items:writeIzveidot un rediģēt vienumus
files:readLejupielādēt failus un attēlus
files:writeAugšupielādēt jaunus failus
items:deleteDzēst vienumus (neatgriezeniski)
Minimālo tiesību princips
Piešķiriet tikai nepieciešamās atļaujas. Piemēram, ja jūsu integrācija tikai lasa datus, neieslēdziet items:write vai items:delete.
Ierobežojiet piekļuvi tikai no konkrētām IP adresēm
Ja norādīts, API atslēga darbosies tikai no šīm IP adresēm vai tīkliem. Atstājiet tukšu, lai atļautu no jebkuras IP.
ATBALSTĪTIE FORMĀTI
192.168.1.100— Konkrēta IP adrese10.0.0.0/24— CIDR notācija (256 adreses)2001:db8::1— IPv6 adrese# Piemērs: Pieļaut tikai no biroja un mākoņa serveriem
192.168.1.100
10.0.0.0/24
185.123.45.67
2001:db8::/32Dinamiskās IP
Ja jūsu serverim ir dinamiska IP adrese (piemēram, mājas internets), IP baltais saraksts var izraisīt piekļuves problēmas. Šādos gadījumos labāk izmantojiet citus drošības mehānismus.
Iestatiet, kad atslēga automātiski beigs darboties
Atslēgai var norādīt derīguma termiņu. Pēc šī datuma atslēga automātiski tiks deaktivēta.
Nekad
Atslēga darbojas bezgalīgi
30 dienas
Īstermiņa piekļuve
Konkrēts datums
Piemēram, 2025-12-31
Ieteikums
Īslaicīgām integrācijām, testēšanai vai trešo pušu piekļuvei vienmēr iestatiet derīguma termiņu. Tas nodrošina, ka aizmirstas atslēgas automātiski tiek deaktivētas.
Katrai atslēgai ir unikāls prefikss, kas norāda tās tipu un mērķi:
vgtk_a_Access Key (Zero-Knowledge)Autentifikācijas atslēga. Šo nosūtāt X-API-Key headerī. Neļauj atšifrēt datus.
vgtk_d_Decryption Key (Zero-Knowledge)Atšifrēšanas atslēga. Glabāt tikai klienta pusē! Nekad nesūtīt serverim.
vgtk_m_Managed Key (Server-Managed)Viena atslēga, kas ļauj gan autentificēties, gan saņemt atšifrētus datus no servera.
vglv_Legacy API v1 KeyRead-only piekļuve visam seifam. Atgriež šifrētus datus (nepieciešams master password).
Visiem API pieprasījumiem jāiekļauj X-API-Key header.
GET /api/v2/tag/items HTTP/1.1
Host: vairogs.lv
X-API-Key: vgtk_a_xxxxxxxxxxxxxx
Content-Type: application/json
# Decryption Key glabājas lokāli
# un izmanto klienta pusēGET /api/v2/tag/items HTTP/1.1
Host: vairogs.lv
X-API-Key: vgtk_m_xxxxxxxxxxxxxx
Content-Type: application/json
# Serveris automātiski atšifrē
# un atgriež skaidrus datus| Parametrs | Tips | Apraksts |
|---|---|---|
X-API-Key* | string | Access Key (vgtk_a_xxx), Managed Key (vgtk_m_xxx), vai Legacy Key (vglv_xxx) |
import { VairogsClient } from '@vairogs/sdk'
// Zero-Knowledge: divas atslēgas, klienta puses atšifrēšana
const client = new VairogsClient({
accessKey: 'vgtk_a_xxxxxxxxxxxxxxxxxxxxxx',
decryptionKey: 'vgtk_d_xxxxxxxxxxxxxxxxxxxxxx' // Tikai lokāli!
})
// SDK automātiski atšifrē klienta pusē
const items = await client.getItems()
console.log(items) // Atšifrēti dati// Server-Managed: viena atslēga, serveris atšifrē
const response = await fetch('https://vairogs.lv/api/v2/tag/items', {
headers: {
'X-API-Key': 'vgtk_m_xxxxxxxxxxxxxxxxxxxxxx'
}
})
const { data } = await response.json()
console.log(data.items) // Jau atšifrēti dati no servera!
// Nav nepieciešama klienta puses kriptogrāfija
// Dati tiek atšifrēti serverī pieprasījuma laikāimport requests
# Server-Managed: vienkāršākā integrācija
headers = {
'X-API-Key': 'vgtk_m_xxxxxxxxxxxxxxxxxxxxxx'
}
response = requests.get('https://vairogs.lv/api/v2/tag/items', headers=headers)
data = response.json()
# Dati jau atšifrēti!
for item in data['data']['items']:
print(f"{item['title']}: {item['decryptedData']}")API pieprasījumiem ir ierobežojumi, lai novērstu ļaunprātīgu izmantošanu:
429 Too Many Requests
429 atbildi ar Retry-After header.401UnauthorizedAPI atslēga nav norādīta, ir nepareiza, vai ir deaktivēta/expired.
403ForbiddenAtslēgai nav nepieciešamās atļaujas šai darbībai, vai IP nav baltajā sarakstā.
429Too Many RequestsPārsniegts rate limit. Gaidiet un mēģiniet vēlreiz.
Izvēlieties pareizo režīmu
Sensitīviem datiem — Zero-Knowledge. Ātriem prototipiem — Server-Managed.
Ierobežojiet atļaujas
Piešķiriet tikai nepieciešamās atļaujas katrai atslēgai.
Izmantojiet IP whitelist
Ja iespējams, ierobežojiet piekļuvi tikai no zināmām IP adresēm.
Iestatiet derīguma termiņu
Īslaicīgām integrācijām vienmēr norādiet termiņu.
Rotējiet atslēgas regulāri
Izveidojiet jaunas atslēgas ik pēc dažiem mēnešiem.
Nekad necommitējiet atslēgas
Izmantojiet environment variables vai secret managers.