/campaigns/{campaign}
Získejte seznam kampaní, info o kampani.
GET /campaigns
Vrací seznam kampaní, ke kterým má uživatel přístup.
Požadavek
Požadavek nemá žádné parametry.
Odpověď
Jednotlivé kampaně jsou v poli data
.
Parametr | Typ | Popis | Příklad |
---|---|---|---|
id |
integer | ID kampaně | 9999 |
slug |
string | URL-friendly řetězec unikátní pro kampaň. | FRAD000001 |
publisher.id |
integer | ID publishera (v současné době bude vždy 1 , jakožto jediným publisherem je [Skrz.cz](https://skrz.cz/)) |
1 |
publisher.title |
string | Název publishera (v současné době bude vždy Skrz.cz , jakožto jediným publisherem je [Skrz.cz](https://skrz.cz/)) |
Skrz.cz |
Příklad
$ curl -u franta@skrz.cz:sedmikraska -X GET https://muj.skrz.cz/api/v2/campaigns?pretty
{
"data": [
{
"id": 9999,
"title": "Frantův eshop",
"slug": "FRAD000001",
"publisher": {
"id": 1,
"title": "Skrz.cz"
},
"uri": "/api/v2/campaigns/9999"
}
]
}
GET /campaigns/{campaign}
Vrací informace o konkrétní kampani.
Požadavek
Parametr | Typ | Popis | Příklad |
---|---|---|---|
campaign |
integer/string | ID kampaně, nebo slug kampaně. |
9999 , nebo FRAD000001 |
Odpověď
Parametr | Typ | Popis | Příklad |
---|---|---|---|
id |
integer | ID kampaně | 9999 |
slug |
string | URL-friendly řetězec unikátní pro kampaň. | FRAD000001 |
publisher.id |
integer | ID publishera (v současné době bude vždy 1 , jakožto jediným publisherem je [Skrz.cz](https://skrz.cz/)) |
1 |
publisher.title |
string | Název publishera (v současné době bude vždy Skrz.cz , jakožto jediným publisherem je [Skrz.cz](https://skrz.cz/)) |
Skrz.cz |
Příklad
$ curl -u franta@skrz.cz:sedmikraska -X GET https://muj.skrz.cz/api/v2/campaigns/9999?pretty
{
"id": 9999,
"title": "Frantův eshop",
"slug": "FRAD000001",
"publisher": {
"id": 1,
"title": "Skrz.cz"
},
"uri": "/api/v2/campaigns/9999"
}