Export kontaktů do XLSX

POST
/api/v2/export/contacts

Vytvoří export všech nesmazaných kontaktů (adresáře) firmy do souboru XLSX. Soubor se uloží na serveru a najdete ho v aplikaci na obrazovce Import / Export. Odpověď obsahuje jen {"result":"success"}, samotný soubor nevrací. Vytvořený soubor lze použít pro import kontaktů (table=exports).

Operace nemá parametry. Každé volání vytvoří nový soubor.

Soubor exportu

Název souboru má tvar {firma}_{uživatel}_adresar_{RRRR_MM_DD_HH_MM_SS}.xlsx (ID firmy a uživatele, čas vzniku). Jediný list obsahuje hlavičku a jeden řádek na kontakt seřazený podle ID. Všechny hodnoty jsou text, prázdná hodnota je prázdná buňka.

Sloupec Hlavička Význam
A Typ Typ kontaktu.
B, C Jmeno, Prijmeni Jméno nebo název firmy a příjmení.
D, E, F Mesto / Obec, Ulice, PSC Adresa.
G Telefon Telefon.
H E-mail E-mail; podle něj import páruje kontakty.
I, J ICO, DIC IČO a DIČ.
K Poznamka Poznámka.
L Datum narozeni Datum narození.
M Kod Kód kontaktu.
N Druhy telefon Druhý telefon (mobil).
O Web Web.
P, Q Kontaktni osoba, Funkce kontaktni osoby Kontaktní osoba a její funkce.
R, S, T Nazev banky, Kod banky, Cislo uctu Bankovní spojení.
U, V IBAN, SWIFT Mezinárodní bankovní údaje.
W ID ID kontaktu v elPokladně; import sloupec nepoužívá.

Sloupce A až V mají stejné pořadí, jaké čte import kontaktů, takže export lze po úpravě nahrát zpět. Postup v aplikaci popisuje návod Import / Export.

Odpověď

Úspěch je JSON s HTTP 200. Chyby přihlášení vrací JSON s status a message, viz Chybové stavy.

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 POST 'https://www.elpokladny.cz/api/v2/export/contacts' \
  -H 'Authorization: Bearer elp_live_example.example_secret'

PHP

<?php
$ch = curl_init('https://www.elpokladny.cz/api/v2/export/contacts');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    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/export/contacts", {
    "method": "POST",
    "headers": {
        "Authorization": "Bearer elp_live_example.example_secret"
    }
});
const data = await response.json();

Ukázkové odpovědi

Export byl vytvořen (HTTP 200)

application/json

{
  "result": "success"
}

Chybí platné přihlášení (HTTP 401)

application/json

{
  "status": "error",
  "message": "Unauthorized"
}

Možné chyby

Chybové stavy

HTTPKdyPodoba
401Chybí API token. Odpověď má hlavičku WWW-Authenticate: Bearer. status-message
401Neplatný, odvolaný nebo expirovaný API token (Bearer, api_token). Odpověď nemá hlavičku WWW-Authenticate. status-message
403API token se použil z IP adresy, která není u přístupu povolená. status-message

Související návody