You are here: Foswiki>Mango Web>CibsDoc10WebServicesMainChapter>CibsDocAPIv1 (06 Mar 2024, KarelBelohlavek)EditAttach

Mango API v1

Obsah:

Účel článku
Endpointy
- Vytvoření tokenu - POST /api/v1/session
- Export zákazníků - GET /api/v1/users
- Smazání tokenu - DELETE /api/v1/session
  - Příklad
V souboru Endpoints/AccountIban.php:
- GET /account-iban
V souboru Endpoints/Admins.php:
- GET /admins
- GET /admins
- 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
- 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
- GET /eu-billing
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
- 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
- GET /node-params
V souboru Endpoints/NodeParamsValidation.php:
- GET /node-params-validation
V souboru Endpoints/Nodes.php:
- GET /nodes
- GET /nodes
- 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
- GET /payment-3dsecure-response
- GET /payment-3dsecure-response
- GET /payment-3dsecure-response
- GET /payment-3dsecure-response
- GET /payment-3dsecure-response
V souboru Endpoints/Payment3DSecureReverse.php:
- POST /payment-3dsecure-reverse
V souboru Endpoints/PhonetCredit.php:
- GET /phonet-credit
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
- 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
- GET /processes
- GET /processes
- GET /processes
- GET /processes
- GET /processes
- GET /processes
- GET /processes
- GET /processes
- GET /processes
- GET /processes
- GET /processes
- POST /processes
- PUT /processes
V souboru Endpoints/ProtectedDataCategories.php:
- GET /protected-data-categories
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
- GET /protected-data-items-categories
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
- GET /service-active-params
V souboru Endpoints/Session.php:
- POST /session
- GET /session
- DELETE /session
V souboru Endpoints/SspDashboard.php:
- GET /ssp-dashboard
- 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
- GET /ssp-processes
- GET /ssp-processes
- 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
- GET /user-service
- GET /user-service
- POST /user-service
- GET /user-service
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

Úč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.

Endpointy

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

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
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"

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"

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: r4 - 06 Mar 2024, KarelBelohlavek

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