Authorization
- Оксана Нечепоренко
Access to all UBKI services is provided when there is a valid session key.
To obtain the session key, the authorization service is used. The key is valid until 23:59:59 the date it was received. The key can be compromised and blocked for various reasons, the service will return a message "Security error. The lifetime of the session key expired. " In such a situation, you have to log in again.
The session key must be obtained only once per day. It is IMPORTANT not to generate a new session key per each request, as this leads to extra load on the services. The session key request is supported in xml/json formats. Must be specified HTTP headers – Content-Type: application/xml or Content-Type: application/json.
Authorization service
Http Method | POST |
|---|---|
Request URL | https://secure.ubki.ua/b2_api_xml/ubki/auth |
Test URL | https://test.ubki.ua/b2_api_xml/ubki/auth |
Request |
|---|
JSON
headers:
Content-Type: application/json
Accept: application/jsonbody:
{
"doc" : {
"auth" : {
"login" : "Login",
"pass" : "Password"
}
}
}XML
headers:
Content-Type: application/xml
Accept: application/xmlbody:
<!-- xml- request should be coded in base64 --!>
Response |
|---|
JSON
body:
XML
body:
When executing an authorization request, in case of an incorrect request or insufficient user account settings, the API will return an error code. To minimize errors when integrating with the API and to properly configure the response, you must analyze all errors received.