Výpis kontaktů ve správě
GET
/api/v2/admin/contactsVrací nesmazané a nejednorázové kontakty firmy, nejnovější první (podle id sestupně). Položka má jen stručné údaje: id, type, name, surname, street, town, zip, phone a ic. Úplný kontakt vrátí detail kontaktu.
Odpověď obsahuje i pole q s hledaným textem, který server použil. Parametr q se ořízne o mezery; prázdný text znamená bez filtru. Výpis nelze stránkovat. Plochý seznam pro prodej s úplnějšími údaji vrací seznam kontaktů.
Autentizace a oprávnění
Vyžaduje API token: Bearer v hlavičce nebo URL token.
Parametry
Query parametry
| Název | Typ | Povinný | Popis | Příklad |
|---|---|---|---|---|
q | string | ne | Hledaný text. Kontakt se vrátí, když ho obsahuje některé z textových polí, ID nebo název ceníku. Bez rozlišení velikosti písmen. | Ukázkový |
Příklad požadavku
curl
curl -X GET 'https://www.elpokladny.cz/api/v2/admin/contacts?q=Uk%C3%A1zkov%C3%BD' \
-H 'Authorization: Bearer elp_live_example.example_secret'PHP
<?php
$ch = curl_init('https://www.elpokladny.cz/api/v2/admin/contacts?q=Uk%C3%A1zkov%C3%BD');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array (
0 => 'Authorization: Bearer elp_live_example.example_secret',
),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;javascript
const response = await fetch("https://www.elpokladny.cz/api/v2/admin/contacts?q=Uk%C3%A1zkov%C3%BD", {
"method": "GET",
"headers": {
"Authorization": "Bearer elp_live_example.example_secret"
}
});
const data = await response.json();Ukázkové odpovědi
Nalezené kontakty (HTTP 200)
application/json
{
"status": "success",
"data": [
{
"id": 21,
"type": "BOTH",
"name": "Ukázkový odběratel s.r.o.",
"surname": null,
"street": "Ukázková 1",
"town": "Praha",
"zip": "11000",
"phone": "+420 123 456 789",
"ic": "12345678"
}
],
"q": "Ukázkový"
}
Chybí platný API token (HTTP 401)
application/json
{
"status": "error",
"message": "Unauthorized"
}
Možné chyby
| HTTP | Kdy | Podoba |
|---|---|---|
| 401 | Chybí nebo je neplatný API token. | status-message |
| 403 | API token se použil z IP adresy, která není u přístupu povolená. | status-message |