You are here: Foswiki>Mango Web>CibsDoc10WebServicesMainChapter>CibsDocAPIv1 (04 May 2024, MichalHornych)EditAttach

Mango API v1

Obsah:

Úč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 --ciphers DEFAULT@SECLEVEL=1 -H "X-Session-Token:$token"  -X DELETE "https://is.cibs.cz/api/v1/session/$token"

Uživatelé (users)

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

Práva a nastavení

Název	Účel	Popis	Hodnoty
*USER_LIST.EXPORT*	nastavení operátora	povoluje operátorovi provádět export seznamu zákazníků	1
CT	nastavení operátora	právo zpřístupňuje lokaci	id lokace

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)

Response parametry

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

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"

Procesy (processes)

Seznam procesů - GET /api/v1/processes

Práva a nastavení

Název	Účel	Popis	Hodnoty
*USER_LIST.EXPORT*	nastavení operátora	povoluje operátorovi provádět export seznamu zákazníků	1
CT	nastavení operátora	právo zpřístupňuje lokaci	id lokace

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"

ToDo:

V souboru Endpoints/AccountIban.php:

GET /account-iban

V souboru Endpoints/Admins.php:

GET /admins

POST /admins

PUT /admins

DELETE /admins

V souboru Endpoints/BankCodes.php:

GET /bank-codes

V souboru Endpoints/ChangePassword.php:

POST /change-password

V souboru Endpoints/Chat.php:

GET /chat

POST /chat

V souboru Endpoints/ChatDownload.php:

GET /chat-download

V souboru Endpoints/ChatMessage.php:

GET /chat-message

POST /chat-message

DELETE /chat-message

GET /chat-message

V souboru Endpoints/ChatMessageFlags.php:

POST /chat-message/{messageId}/flags

V souboru Endpoints/CheckCodeValidity.php:

GET /check-code-validity

V souboru Endpoints/CheckSession.php:

GET /check-session

V souboru Endpoints/CheckUniqueEmail.php:

GET /check-unique-email

V souboru Endpoints/CodeList.php:

V souboru Endpoints/DbReady.php:

GET /db-ready

V souboru Endpoints/DocumentsAgreements.php:

GET /documents-agreements

V souboru Endpoints/DocumentsAgreementsConfirmed.php:

POST /documents-agreements-confirmed

GET /documents-agreements-confirmed

V souboru Endpoints/DocumentsAgreementsUnConfirmed.php:

GET /document-agreement-unconfirmed

V souboru Endpoints/DocumentsOther.php:

GET /documents-other

V souboru Endpoints/DocumentsOtherTypes.php:

V souboru Endpoints/DomainPattern.php:

GET /domain-pattern

V souboru Endpoints/DxMonitoring.php:

GET /dx-monitoring

V souboru Endpoints/EUUnicredit.php:

V souboru Endpoints/EditorBlock.php:

V souboru Endpoints/EditorBlockContent.php:

GET /editor-block-content

V souboru Endpoints/EndUserParams.php:

GET /user-params

V souboru Endpoints/EuBilling.php:

GET /eu-billing

/user-debt

GET /eu-billing

/user-debt

V souboru Endpoints/EuContacts.php:

GET /eu-contacts

POST /eu-contacts

PUT /eu-contacts

DELETE /eu-contacts

V souboru Endpoints/EuSession.php:

V souboru Endpoints/EuUser.php:

GET /eu-user

POST /eu-user

V souboru Endpoints/EuUserInfo.php:

V souboru Endpoints/InetData.php:

GET /inet-data

V souboru Endpoints/InstallationConfig.php:

GET /installation-config

V souboru Endpoints/NewProcessParams.php:

GET /new-process-params

V souboru Endpoints/NodeParams.php:

GET /node-params

V souboru Endpoints/NodeParamsValidation.php:

GET /node-params-validation

V souboru Endpoints/Nodes.php:

GET /nodes

POST /nodes

V souboru Endpoints/PayOrder.php:

GET /pay-order

POST /pay-order

V souboru Endpoints/Payment3DSecureEcho.php:

POST /payment-3dsecure-echo

GET /payment-3dsecure-echo

V souboru Endpoints/Payment3DSecureRequest.php:

POST /payment-3dsecure-request

V souboru Endpoints/Payment3DSecureResponse.php:

POST /payment-3dsecure-response

GET /payment-3dsecure-response

V souboru Endpoints/Payment3DSecureReverse.php:

POST /payment-3dsecure-reverse

V souboru Endpoints/PhonetCredit.php:

GET /phonet-credit

/phonet-credit-get

V souboru Endpoints/PhonetCreditLoad.php:

POST /phonet-credit-load

V souboru Endpoints/PremiseParams.php:

V souboru Endpoints/PrintDocument.php:

GET /print-document

V souboru Endpoints/ProcessAttachment.php:

GET /process-attachment

POST /process-attachment

PUT /process-attachment

V souboru Endpoints/ProcessHistory.php:

GET /process-history

POST /process-history

V souboru Endpoints/ProcessNew.php:

GET /process-new

V souboru Endpoints/ProcessParams.php:

GET /process-params

POST /process-params

V souboru Endpoints/ProcessParamsDef.php:

GET /process-params-def

V souboru Endpoints/ProcessParamsSet.php:

POST /process-params-set/{processId}

V souboru Endpoints/ProcessPremises.php:

GET /process-premises

V souboru Endpoints/ProcessServices.php:

GET /process-services

V souboru Endpoints/ProcessStatesHistory.php:

GET /process-states-history

V souboru Endpoints/ProcessTableParamsUpdate.php:

POST /process-table-params-update

V souboru Endpoints/ProcessTypes.php:

GET /process-types

V souboru Endpoints/ProcessUnits.php:

GET /process-units

V souboru Endpoints/Processes.php:

GET /processes

POST /processes

PUT /processes

V souboru Endpoints/ProtectedDataCategories.php:

GET /protected-data-categories

/protected-data-categories-public

V souboru Endpoints/ProtectedDataCategoryConsentAdd.php:

POST /protected-data-category-consent-add

V souboru Endpoints/ProtectedDataCategoryConsentRecall.php:

POST /protected-data-category-consent-recall

V souboru Endpoints/ProtectedDataItemsCategories.php:

GET /protected-data-items-categories

/protected-data-items-categories-registration

GET /protected-data-items-categories

/protected-data-items-categories-registration

V souboru Endpoints/Registration.php:

POST /registration

V souboru Endpoints/ResetPassword.php:

POST /reset-password

V souboru Endpoints/RmRedirectHandle.php:

GET /rm-redir

POST /rm-redir

V souboru Endpoints/SearchAddress.php:

GET /search-address

V souboru Endpoints/ServiceActiveParams.php:

GET /service-active-params

V souboru Endpoints/Session.php:

POST /session

GET /session

DELETE /session

V souboru Endpoints/SspDashboard.php:

GET /ssp-dashboard

V souboru Endpoints/SspProcessAttachment.php:

GET /ssp-process-attachment

V souboru Endpoints/SspProcessParams.php:

V souboru Endpoints/SspProcessWarningsCount.php:

GET /ssp-process-warnings-count

POST /ssp-process-warnings-count

V souboru Endpoints/SspProcesses.php:

GET /ssp-processes

V souboru Endpoints/TelephonyFreeUnits.php:

GET /telephony-free-units

V souboru Endpoints/TelephonyList.php:

GET /telephony-list

V souboru Endpoints/TelephonyNumbers.php:

V souboru Endpoints/Units.php:

GET /units

V souboru Endpoints/UserPayments.php:

GET /user-payments

V souboru Endpoints/UserService.php:

GET /user-service

/user-services-state

GET /user-service

/user-services-state

GET /user-service

/user-services-state

POST /user-service

/user-services-state

GET /user-service

/user-services-state

V souboru Endpoints/UserUnicredit.php:

GET /user-unicredit

V souboru Endpoints/Users.php:

GET /users

POST /users

PUT /users

DELETE /users

V souboru Endpoints/ValueDomain.php:

GET /value-domain-resolve

Zpět na:

Rozhraní API

Topic revision: r5 - 04 May 2024, MichalHornych

Mango

Webs
Main
Mango
Sandbox
System

Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback