In this section of the documentation provides information about the UkrcardAPI (hereinafter referred to as UAPI), sets out the requirements for the interface and methods for interacting with external systems.Full name of the system: Ukrcard Internet gateway UkrcardAPI System acronym: UAPI Communication protocol: RESTObjects of UAPI WEB service
Card (cards):
Card product (cardprod):
Accounts:
Mobile application (mapp):
Directory (dict):
Services:
Information (info):
METHODSThe following methods of working with objects are supported:
GET – get the parameters of the specified object
PUT – change the parameters of the specified object
POST – change the parameters of the specified object
RESPONSE INDICATORS
1.
X-aplication-status Status of the request processing result. Possible statuses are given in Appendix 1.
2.
ErrorInfo – code (error_code) and text of the error (error_message) that occurred when receiving or processing a request. error_code – code. Present only in responses with a status other than X-application-status=2xx
RESPONSE UPDATE AND VERSIONING (WEB SERVICE)If the list of WEB service functions has been expanded, but the interface of existing WEB service functions has not changed, then the WEB service is updated regardless of the update of its clients. After updating the WEB service, the developers of its WEB clients independently make decisions on the use of new functions of the WEB service. If the interface of WEB service functions has changed, then updating the WEB service is performed as follows:
A new WEB service is being created.
A new WEB service is published at a new address, which in its structure contains a version (Vxx, where xx is the version number).
Information about the new WEB service is communicated to the developers of its clients.
After installing a WEB service, the developers of its clients independently make decisions on the use of the new service.
