Zaslat dokumentace

Úvod k API v1

Zaslat API v1 slouží k získávání nabídek přepravy, vytváření a správě zásilek, žádostem o svoz, čtení číselníku podacích/výdejních míst a správě adresáře kontaktů.

Kompletní referenci endpointů, parametrů a datových schémat najdete v API Referenci. Tato sekce doplňuje kontext a rozšíření, která se do referenční dokumentace nehodí.

Kompletní OpenAPI specifikaci si můžete stáhnout ve formátu YAML — hodí se pro import do nástrojů (Postman, Insomnia) i jako podklad pro AI agenty a generátory klientů.

Autentizace

Všechny požadavky je nutné posílat s autentizačním HTTP headerem x-apikey. Produkční API klíč najdete ve správním rozhraní (app.zaslat.cz) v sekci API (Nastavení uživatele).

Neplatný klíč nemusí skončit chybou

Některé endpointy (rates/get, shipments/create, shipments/validate, shipments/detail, shipments/tracking) fungují i bez přihlášení. Požadavek s neplatným klíčem na nich neskončí chybou 401, ale zpracuje se jako nepřihlášený — objednávka pak vznikne bez vazby na váš účet (vždy s platbou ONLINE, payer je povinný) a shipments/detail vrací jen veřejná pole. Chyba 401 se objeví až na endpointech vyžadujících přihlášení (např. shipments/label). Platnost klíče si na začátku integrace ověřte voláním GET /shipments/list.

Testovací prostředí

Pro vývoj a ladění integrace je k dispozici oddělené testovací prostředí na adrese https://test.zaslat.cz/api/v1. Testovací API klíč získáte stejným postupem v testovacím správním rozhraní na app-test.zaslat.cz — účty a data jsou od produkce zcela oddělené. Produkční klíč na testovacím prostředí neplatí (a naopak); viz upozornění výše.

Identifikace integrace (source)

Pokud objednávky vytváří partnerská integrace (modul pro e-shop, plugin, aplikace třetí strany), uveďte v kořeni požadavku POST /shipments/create pole source s identifikátorem integrace. Zaslat podle něj eviduje zdroj objednávek; na cenu, zpracování ani odpověď API nemá vliv.

JSONCode
{
    "source": "Alsendo Connect: PrestaShop",
    "currency": "CZK",
    "payment_type": "CREDIT",
    "shipments": [ ... ]
}
  • Identifikátor vám přidělíme při zavedení integrace — ozvěte se na podpora@zaslat.cz. Neznámá hodnota se tiše ignoruje a objednávka se eviduje jako běžná objednávka přes API.
  • Na velikosti písmen nezáleží, mezery se ignorují.
  • Pluginy Alsendo Connect uvádějí Alsendo Connect: <platforma> (PrestaShop, WooCommerce, OpenCart, Shopify).
  • Pole se v odpovědích API nevrací.

Obsah sekce

Last modified on
WebczechObjednávka ze svozové adresy