Integrace

Erpena API

Propojte Erpenu s dalšími firemními systémy přes standardní REST API.

Vedle připravených integrací, které používáte přímo v Erpeně, můžete přes API napojit vlastní aplikace nebo existující firemní systémy a automatizovat výměnu dat.

Otevřít API dokumentaci
REST API JSON JWT OpenAPI

Vlastní integrace

API jako otevřené rozhraní Erpeny

API je určené pro situace, kdy potřebujete Erpenu propojit se systémem, pro který není připravená standardní integrace. Může jít například o ERP, účetní systém, e-shop, datový sklad, vlastní interní aplikaci nebo jinou firemní službu.

Integrace tak může pracovat s podporovanými daty Erpeny a navázat je na další firemní procesy bez ručního přenosu informací mezi systémy.

Aktuální rozsah

Co je dnes v API dostupné

Současné API zpřístupňuje vybrané hlavní agendy Erpeny. Přesný a vždy aktuální seznam podporovaných metod, parametrů a datových modelů najdete v OpenAPI dokumentaci.

Zákazníci, leady, kontakty a adresy

Načítání, vyhledávání, zakládání a úpravy zákazníků a leadů včetně kontaktů, adres a převodu leadu na zákazníka.

Objednávky

Zakládání a načítání objednávek, práce s položkami, komentáři, přiřazením a změnami stavů.

Úkoly

Načítání, vyhledávání, zakládání a úpravy úkolů včetně stavů, přiřazení a komentářů.

Tikety

Práce s tikety zákaznické podpory, jejich stavy, komentáři, přiřazením, řešením a znovuotevřením.

Billing

Vytváření a vyhledávání billingů, práce s položkami a navazujícími fakturačními operacemi.

Rozsah API průběžně rozšiřujeme podle potřeb zákazníků a konkrétních integrací. OpenAPI dokumentace je proto zdrojem aktuálního seznamu podporovaných metod.

Technicky

Jak se k API připojit

API komunikuje pomocí JSON a používá tokenovou autentizaci. Následující ukázky jsou pouze orientační

1. Získání přístupového tokenu

Přihlašovací metoda vrátí token, který následně používáte pro autorizaci dalších požadavků.

POST {login-endpoint}
Content-Type: application/json

{
  "profile": "your-profile",
  "password": "your-password"
}

2. Volání konkrétní metody

Token odešlete v hlavičce Authorization a zavoláte požadovanou metodu, například načtení detailu zákazníka.

GET {customer-detail-endpoint}
Authorization: Bearer {token}
Accept: application/json

{
  "customerRefId": "CUST-001",
  "customerName": "Example s.r.o.",
  "companyIdentification": "12345678",
  "defaultEmail": "info@example.com"
}

Konkrétní metody najdete v OpenAPI dokumentaci

Interaktivní dokumentace je jediným místem, kde udržujeme aktuální technický popis API – dostupné metody, parametry, povinná pole, datové modely, návratové kódy i možnost jednotlivá volání vyzkoušet.

Otevřít API dokumentaci