Detail kontaktu
GET
/api/v2/admin/contacts/{id}Vrací kontakt se všemi poli, která lze číst i zapisovat, a options.priceLists se seznamem ceníků firmy pro výběr. priceListId a priceList mají stejnou hodnotu (ID ceníku, nebo null). Najít lze i jednorázový kontakt (disposable: true).
Autentizace a oprávnění
Vyžaduje API token: Bearer v hlavičce nebo URL token.
Parametry
Parametry cesty
| Název | Typ | Povinný | Popis | Příklad |
|---|---|---|---|---|
id | integer | ano | ID kontaktu vaší firmy. | 21 |
Příklad požadavku
curl
curl -X GET 'https://www.elpokladny.cz/api/v2/admin/contacts/21' \
-H 'Authorization: Bearer elp_live_example.example_secret'PHP
<?php
$ch = curl_init('https://www.elpokladny.cz/api/v2/admin/contacts/21');
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/21", {
"method": "GET",
"headers": {
"Authorization": "Bearer elp_live_example.example_secret"
}
});
const data = await response.json();Ukázkové odpovědi
Detail kontaktu (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",
"disposable": false,
"alias": null,
"code": "ODB1",
"email": "info@example.com",
"mobile": null,
"web": "www.example.com",
"person": "Jana Ukázková",
"function": null,
"dic": "CZ12345678",
"birth": null,
"bank": "Ukázková banka",
"bankCode": "0100",
"accountNumber": "123456789",
"iban": null,
"swift": null,
"text": null,
"priceListId": 2,
"priceList": 2
},
"options": {
"priceLists": [
{
"id": 2,
"name": "Velkoobchod"
}
]
},
"isNew": false
}
Kontakt neexistuje (HTTP 404)
application/json
{
"status": "error",
"message": "Kontakt nebyl nalezen."
}
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 |
| 404 | Kontakt s tímto ID neexistuje, je smazaný, nebo patří jiné firmě. | status-message |