Mango API v1

Účel článku

Článek má za cíl zdokumentování Mango REST API v1. Dokumentaci postupně doplňujeme. API lze volat na produkční doméně https://is.cibs.cz nebo testovací https://test.cibs.cz.

Přihlášení, autorizace, autentikace

---

Vytvoření tokenu - POST /api/v1/session

Request parametry

Parametr	Popis
username	login operátora
password	heslo operátora
ct	id lokace

Response parametry

Parametr	Popis
backendLoginId	id operátora
logLevel	úroveň logování
ct	id lokace
token	autentizační token
atb

Příklad

curl -d username=$login -d password=$heslo -d ct=$ct https://is.cibs.cz/api/v1/session

---

Smazání tokenu - DELETE /api/v1/session

Příklad

curl -s -H "X-Session-Token:$token"  -X DELETE "https://is.cibs.cz/api/v1/session/$token"

Pokud by se vyskytla chybová hláška obsahující error ohledně sady šifer, lze k tomuto příkazu přidat parametr --ciphers DEFAULT@SECLEVEL=1.

Uživatelé (users)

---

Export zákazníků - GET /api/v1/users

Práva a nastavení

Popis práv a možnosti hodnot najdete pod odkazem.

Název
USER_LIST.EXPORT
CT

Request parametry

Parametr	Popis
limit	počet záznamů načítaných jedním voláním
offset	index prvního záznamu v případě postupného načítání (viz limit)
userId	id existujícího zákazníka (vrací pouze 1 záznam k tomuto id)
agreementName	Číslo smlouvy existujícího zákazníka (vrací pouze záznamy k tomuto číslu)

Response parametry

Parametr	Popis
id	id zákazníka
type	typ zákazníka (soukromá/fyzická/právnická)
degree	titul za jménem
firstName	jméno
lastName	příjmení
degreeBehind	titul před jménem
companyName	společnost
companyId	IČO
companyFid	DIČ
groupCompanyFid	skupinové DIČ
companyVatId	IČ DPH
statutary	statutární orgán
personalNumber	rodné číslo
dayOfBirth	datum narození
documentNumber	číslo dokladu
fax	faxové číslo
premises	příznak evidence provozven
codeReference	ID doporučujícího zákazníka
login	přihlašovací jméno
street	adresa sídla/trvalého bydliště - ulice
houseId	adresa sídla/trvalého bydliště - číslo popisné
zip	adresa sídla/trvalého bydliště - PSČ
city	adresa sídla/trvalého bydliště - obec
mailingAddress	doručovací adresa - shodná s adresou sídla/trvalého bydliště nebo vlastní "AS1"/"OWN"
mailingAddressRecipient	doručovací adresa - příjemce
mailingAddressStreet	doručovací adresa - ulice
mailingAddressHouseId	doručovací adresa - číslo popisné
mailingAddressZip	doručovací adresa - IČO
mailingAddressCity	doručovací adresa - obec
billingAddress	fakturační adresa - shodná s adresou sídla/trvalého bydliště nebo shodná s doručobvací adresou nebo vlastní "AS1"/"AS2"/OWN"
billingAddressRecipient	fakturační adresa - příjemce
billingAddressStreet	fakturační adresa - ulice
billingAddressHouseId	fakturační adresa - číslo popisné
billingAddressZip	fakturační adresa - PSČ
billingAddressCity	fakturační adresa - obec
accountPreNumber	předčíslí bankovního spojení
accountNumber	číslo účtu bankovního spojení
accountBank	číslo banky bankovního spojení
accountIban	IBAN bankovního spojení
accountSpecSym	specifický symbol bankovního spojení
sipo	spojovací šíslo SIPO
agreementName	číslo smlouvy
accountVarSym	variabilní symbol
codeName	kódové označení
valuation	zhodnocení zákazníka
providerType	typ poskytovatele "DEFAULT_PROVIDER"/"NONE"/"PROVIDER"
phones	telefonní čísla
emails	emaily
U_BP_IDS	seznam id povolených billing plánů
vatRegistered	plátce daně
dateTest	datum narození
dateTimeTest	datum aktivace
infoMarketing	souhlas se zasíláním marketingových sdělení
infoEmail	komunikační kanál email
infoPost	komunikační kanál pošta
infoSms	komunikační kanál sms
active	stav zákazníka (-1 neaktivní trvale/0 neaktivní dočasně/1 aktivní)

Příklad

#export všech zákazníků v jednom bloku
curl -v -H "X-Session-Token:$token" https://is.cibs.cz/api/v1/users

#export všech zákazníků po blocích
curl -v -H "X-Session-Token:$token" "https://is.cibs.cz/api/v1/users?limit=10&offset=0"
curl -v -H "X-Session-Token:$token" "https://is.cibs.cz/api/v1/users?limit=10&offset=10"
curl -v -H "X-Session-Token:$token" "https://is.cibs.cz/api/v1/users?limit=10&offset=20"
...

#export 1 zákazníka s id 123456
curl -v -H "X-Session-Token:$token" "https://is.cibs.cz/api/v1/users?userId=123456"

#export 1 zákazníka s č. smlouvy 123456
curl -v -H "X-Session-Token:$token" "https://is.cibs.cz/api/v1/users?agreementName=123456"

---

Procesy (processes)

Seznam procesů - GET /api/v1/processes

Práva a nastavení

Popis práv a možnosti hodnot najdete pod odkazem.

Název
CT

Request parametry

Parametr	Popis
limit	počet záznamů načítaných jedním voláním
offset	index prvního záznamu v případě postupného načítání (viz limit)
state	Název stavu procesů.
activeOnly	Filtr pouze aktivních (neukončených) procesů.
typeId	Id typ procesu. Může být zadáno i více hodnot, pak se zadají jako čárkou oddělený seznam.
userId	Id zákazníka na kterého jsou evidovány procesy.
unit	Id jednotky na kterou jsou navázány procesy.
dateFrom	Datum (a čas) zahájení procesu je větší nebo rovno než zadaná hodnota. Hodnota se zadává ve formátu YYYY-MM-DD [hh:mm:ss].
dateTo	Datum (a čas) zahájení procesu je menší nebo rovno než zadaná hodnota. Hodnota se zadává ve formátu YYYY-MM-DD [hh:mm:ss].
lastActivityFrom	Datum (a čas) poslední aktivity v procesu je větší nebo rovno než zadaná hodnota. Hodnota se zadává ve formátu YYYY-MM-DD [hh:mm:ss].
lastActivityTo	Datum (a čas) poslední aktivity v procesu je menší nebo rovno než zadaná hodnota. Hodnota se zadává ve formátu YYYY-MM-DD [hh:mm:ss].
PARAM_NAME	Je možné filtrovat pomocí jakéhokoliv uživatelsky definovaného parametru procesu. Název parametru se zapisuje velkými písmeny.

Response parametry

Parametr	Popis
id	Id procesu
typeId	Id typu procesu
typeName	Název typu procesu. Příklad: "Proces"
stateName	Název stavu procesu. Příklad: "Nahlášeno"
name	Název procesu
description	Popis procesu
priorityName	Název priority
startTime	Datum a čas zahájení procesu. Příklad: "2024-05-04T13:55:42+02:00"
lastActivity	Datum a čas poslední aktivity v procesu. Příklad: "2024-05-04T13:55:46+02:00"
userId	Id uživatele přiřazeného k procesu
unreadMessages	Počet nepřečtených zpráv v chatu. Je relevantní jen u procesů používajících chat
warning	Počet warování chatu. Je relevantní jen u procesů použíajících chat
editable	Příznak editovatelnosti procesu uživatelem (podle práv, stavu procesu, atd.)
PARAM_NAME	Všechny uživatelsky definované parametry procesu jsou uvedeny velkými písmeny. Pro každý parametr je jeden parametr response. Příklad: "MY_PARAM" = "Hodnota_1234"
transitions	Seznam (pole) všech dostupných přechodů stavu procesu. Vychází z aktuálního stavu procesu a práv uživatele.

Příklad

# získání seznamu všech procesů v jednom bloku
curl -v -H "X-Session-Token:$token" https://is.cibs.cz/api/v1/processes

# získání seznamu všech procesů po stránkách
curl -v -H "X-Session-Token:$token" "https://is.cibs.cz/api/v1/processes?limit=10&offset=0"
curl -v -H "X-Session-Token:$token" "https://is.cibs.cz/api/v1/processes?limit=10&offset=10"
curl -v -H "X-Session-Token:$token" "https://is.cibs.cz/api/v1/processes?limit=10&offset=20"
...

# získání seznamu všech procesů s uživatelkým filtrem času zahájení procesu větším než
curl -v -H "X-Session-Token:$token" "https://is.cibs.cz/api/v1/processes?dateFrom="2024-05-01"

---

Zpět na:

• Rozhraní API