Seznam kontaktů
GET
/api/v2/contactsVrací všechny kontakty firmy, které nejsou smazané ani jednorázové, seřazené podle názvu. Operace nemá parametry a výpis nelze filtrovat ani stránkovat. Pro vyhledávání a správu kontaktů slouží správa kontaktů.
Položky mají plochý tvar vhodný pro výběr kontaktu při prodeji:
| Pole | Význam |
|---|---|
id |
ID kontaktu, které se předává do dokladu jako contact.id. |
priceList |
ID přiřazeného ceníku, 0 když nemá žádný. |
position |
Pořadí v tomto výpisu od 0. |
disposable |
Vždy 0, jednorázové kontakty se nevrací. |
type |
BOTH, SUB, SUP nebo CUS; u staršího kontaktu bez typu může být null. |
name, surname, street, town, zip, ic, dic, email, phone, mobile, web, birth, code, person, function, bank, bankCode, accountNumber, iban, swift, text |
Údaje kontaktu. Chybějící hodnota je prázdný řetězec. |
Autentizace a oprávnění
Vyžaduje API token: Bearer v hlavičce nebo URL token.
Parametry
Operace nemá žádné parametry.
Příklad požadavku
curl
curl -X GET 'https://www.elpokladny.cz/api/v2/contacts' \
-H 'Authorization: Bearer elp_live_example.example_secret'PHP
<?php
$ch = curl_init('https://www.elpokladny.cz/api/v2/contacts');
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/contacts", {
"method": "GET",
"headers": {
"Authorization": "Bearer elp_live_example.example_secret"
}
});
const data = await response.json();Ukázkové odpovědi
Seznam kontaktů (HTTP 200)
application/json
{
"status": "success",
"data": [
{
"id": 21,
"priceList": 2,
"position": 0,
"disposable": 0,
"type": "BOTH",
"name": "Ukázkový odběratel s.r.o.",
"surname": "",
"town": "Praha",
"street": "Ukázková 1",
"zip": "11000",
"ic": "12345678",
"dic": "CZ12345678",
"email": "info@example.com",
"phone": "+420 123 456 789",
"birth": "",
"code": "ODB1",
"mobile": "",
"web": "www.example.com",
"person": "Jana Ukázková",
"function": "",
"bank": "Ukázková banka",
"bankCode": "0100",
"accountNumber": "123456789",
"iban": "",
"swift": "",
"text": ""
}
]
}
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 |