Public API
Kompletná dokumentácia Consentio REST API pre vývojárov
Prehľad
Consentio Public API umožňuje programový prístup k vašim údajom o súhlasoch. Môžete ho použiť na:
- Integráciu s vlastnými analytickými nástrojmi
- Export údajov pre reporty
- Kontrolu využitia oproti limitom plánu
- Vytvorenie vlastných dashboardov
Autentifikácia
API používa autentifikáciu pomocou API kľúča. Kľúč odovzdávate v hlavičke Authorization:
Authorization: ApiKey sk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Získanie API kľúča
- Prihláste sa do dashboardu Consentio
- Prejdite do Nastavenia → API kľúče
- Kliknite na Nový kľúč
- Skopírujte kľúč a bezpečne ho uložte
Base URL
Všetky API požiadavky smerujte na:
https://consentio.cz/api/v1
Rate Limiting
API má limit na počet požiadaviek za hodinu:
| Plán | Požiadavky/hodinu |
|---|---|
| Pro, Agency | 1 000 |
V odpovedi nájdete hlavičky s informáciami o limite:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 950
X-RateLimit-Reset: 2025-01-15T15:00:00.000Z
Formát odpovedí
Všetky odpovede sú vo formáte JSON a majú jednotnú štruktúru:
Úspešná odpoveď
{
"success": true,
"data": { ... }
}
Odpoveď s chybou
{
"error": true,
"statusCode": 400,
"statusMessage": "Bad Request",
"data": {
"success": false,
"error": {
"code": "ERROR_CODE",
"message": "Popis chyby"
}
}
}
Endpointy
GET /websites
Vráti zoznam všetkých webov priradených k vášmu účtu.
Príklad požiadavky
curl -X GET "https://consentio.cz/api/v1/websites" \
-H "Authorization: ApiKey sk_live_xxx"
Príklad odpovede
{
"success": true,
"data": [
{
"id": "clx1234567890",
"name": "Můj e-shop",
"domain": "muj-eshop.cz",
"description": "Hlavní e-shop",
"status": "active",
"cookieCount": 15,
"consentCount": 1250,
"consentRate": 78,
"viewsThisMonth": 450,
"lastScanAt": "2025-01-15T10:30:00.000Z",
"createdAt": "2024-06-01T08:00:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}
]
}
GET /websites/:id
Vráti detail konkrétneho webu vrátane posledných skenov.
Parametre
| Parameter | Typ | Popis |
|---|---|---|
id |
string | ID webu (v URL) |
Príklad požiadavky
curl -X GET "https://consentio.cz/api/v1/websites/clx1234567890" \
-H "Authorization: ApiKey sk_live_xxx"
GET /websites/:id/cookies
Vráti zoznam cookies zistených na webe.
Príklad požiadavky
curl -X GET "https://consentio.cz/api/v1/websites/clx1234567890/cookies" \
-H "Authorization: ApiKey sk_live_xxx"
GET /analytics
Vráti analytické údaje pre web - štatistiky súhlasov, geografiu, zariadenia a trendy.
Query parametre
| Parameter | Typ | Povinný | Popis |
|---|---|---|---|
websiteId |
string | Áno | ID webu |
period |
string | Nie | Obdobie: 7d, 30d, 90d, all (predvolene: 30d) |
Príklad požiadavky
curl -X GET "https://consentio.cz/api/v1/analytics?websiteId=clx123&period=30d" \
-H "Authorization: ApiKey sk_live_xxx"
Príklad odpovede
{
"success": true,
"data": {
"summary": {
"totalViews": 1250,
"consentRate": 78.5,
"acceptedCount": 850,
"rejectedCount": 275,
"customCount": 125,
"uniqueVisitors": 980,
"totalImpressions": 2500
},
"consentBreakdown": {
"acceptAll": 68,
"rejectAll": 22,
"custom": 10
},
"categoryConsent": {
"necessary": 100,
"analytics": 72,
"marketing": 45,
"preferences": 58
},
"geographic": [
{
"country": "Česko",
"countryCode": "CZ",
"flag": "🇨🇿",
"count": 850,
"percentage": 68
}
],
"devices": {
"desktop": 55,
"mobile": 40,
"tablet": 5
},
"trend": [
{
"date": "2025-01-01",
"views": 45,
"accepted": 35,
"rejected": 10
}
],
"utmBreakdown": {
"sources": [...],
"mediums": [...],
"campaigns": [...]
}
}
}
GET /consents
Vráti zoznam jednotlivých súhlasov so stránkovaním. Kategória functionality sa vracia pod kľúčom preferences.
Query parametre
| Parameter | Typ | Povinný | Popis |
|---|---|---|---|
websiteId |
string | Áno | ID webu |
startDate |
ISO 8601 | Nie | Od dátumu (napr. 2025-01-01) |
endDate |
ISO 8601 | Nie | Do dátumu |
limit |
number | Nie | Počet záznamov (predvolene: 100, max: 1000) |
offset |
number | Nie | Počet preskočených záznamov (predvolene: 0) |
Príklad požiadavky
curl -X GET "https://consentio.cz/api/v1/consents?websiteId=clx123&limit=50&offset=0" \
-H "Authorization: ApiKey sk_live_xxx"
Príklad odpovede
{
"success": true,
"data": [
{
"id": "consent_abc123",
"visitorId": "v_xyz789",
"action": "ACCEPT_ALL",
"categories": {
"necessary": true,
"analytics": true,
"marketing": true,
"preferences": true
},
"ipCountry": "CZ",
"device": "desktop",
"utmSource": "google",
"utmMedium": "cpc",
"utmCampaign": "brand",
"createdAt": "2025-01-15T14:30:00.000Z"
}
],
"meta": {
"page": 1,
"limit": 50,
"total": 1250,
"hasMore": true
}
}
POST /consents/export
Exportuje súhlasy do súboru CSV alebo JSON. Najviac 10 exportov za hodinu.
Parametre v tele požiadavky
| Parameter | Typ | Povinný | Popis |
|---|---|---|---|
websiteId |
string | Áno | ID webu |
startDate |
ISO 8601 | Nie | Od dátumu |
endDate |
ISO 8601 | Nie | Do dátumu |
format |
string | Nie | "csv" alebo "json" (predvolene: json) |
Príklad požiadavky
curl -X POST "https://consentio.cz/api/v1/consents/export" \
-H "Authorization: ApiKey sk_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"websiteId": "clx1234567890",
"startDate": "2025-01-01",
"endDate": "2025-01-31",
"format": "csv"
}' \
-o consents.csv
GET /account/usage
Vráti aktuálne využitie účtu vs. limity plánu.
Príklad požiadavky
curl -X GET "https://consentio.cz/api/v1/account/usage" \
-H "Authorization: ApiKey sk_live_xxx"
Príklad odpovede
{
"success": true,
"data": {
"plan": "PRO",
"websites": {
"used": 3,
"limit": 10
},
"pageviews": {
"used": 45000,
"limit": 500000,
"periodStart": "2025-01-01T00:00:00.000Z",
"periodEnd": "2025-01-31T23:59:59.999Z"
},
"analyticsRetention": "unlimited",
"scanInterval": "1 day",
"apiRequests": {
"used": 150,
"limit": 1000,
"resetAt": "2025-01-15T15:00:00.000Z"
}
}
}
Chybové kódy
| HTTP Status | Kód | Popis |
|---|---|---|
| 400 | MISSING_WEBSITE_ID |
Chýba povinný parameter websiteId |
| 400 | INVALID_FORMAT |
Neplatný formát exportu |
| 401 | MISSING_API_KEY, INVALID_API_KEY_FORMAT, INVALID_API_KEY |
Chýbajúci alebo neplatný API kľúč |
| 403 | PLAN_RESTRICTION |
Váš plán nemá prístup k API |
| 404 | WEBSITE_NOT_FOUND |
Web sa nenašiel alebo k nemu nemáte prístup |
| 429 | RATE_LIMIT_EXCEEDED |
Prekročený limit požiadaviek |
| 500 | — | Interná chyba servera |
SDK a knižnice
Oficiálne SDK zatiaľ nemáme. API je obyčajné HTTPS s JSON, takže stačí HTTP klient vášho jazyka:
- JavaScript/TypeScript (
fetch) - Python (
requests) - PHP (cURL)