Авторизация для клиентов

Авторизация для клиентов 1.0.1

0
No votes yet
expand_moreexpand_lessContact information
production
development
https://api.bcc.kz:10443/bcc/production

Альтернативная точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"

production
https://api.bcc.kz/bcc/production

Точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"

development
https://api-test.bcc.kz/bcc/production

Точка подключения для вызова сервисов в тестовой среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"

Paths

/token

post /token

Аутентификация и получение токена

Authorization
Authorization
(oauth2 application)

Токен аутентификации, полученный при вызове сервиса авторизации

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.business.account.management
Allow access to Busines Account Management API
redirect_uri
Optional in formData
string

Redirect URI (пример: https://myapp.com/callback)

grant_type
Required in formData
string

Grant type (только authorization_code или refresh_token)

client_secret
Optional in formData
string

Защищенный ключ

code
Optional in formData
string

Authorization code (если grant_type: "authorization_code")

refresh_token
Optional in formData
string

Refresh token (если grant_type: "refresh_token")

Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

{
    "schema": {
        "type": "object",
        "properties": {
            "access_token": {
                "type": "string",
                "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
            },
            "token_type": {
                "type": "string",
                "example": "bearer"
            },
            "refresh_token": {
                "type": "string",
                "example": "eyJhbRefresh..."
            },
            "expires_in": {
                "type": "integer",
                "example": 300
            },
            "scope": {
                "type": "string",
                "example": "openid"
            }
        }
    }
}
400

Bad Request.

{
    "schema": {
        "type": "object",
        "properties": {
            "error": {
                "type": "string",
                "example": "invalid_request"
            },
            "error_description": {
                "type": "string",
                "example": "Some description about the error."
            }
        }
    }
}
401

Unauthorized.

{
    "schema": {
        "type": "object",
        "properties": {
            "error": {
                "type": "string",
                "example": "unauthorized"
            },
            "error_description": {
                "type": "string",
                "example": "Unauthorized access."
            }
        }
    }
}
Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/auth-client/token
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/auth-client/token
content-type
accept
redirect_uri
grant_type
client_secret
code
refresh_token

/generate-auth-url

post /generate-auth-url

Генерация URL для авторизации

Authorization
Authorization
(oauth2 application)

Токен аутентификации, полученный при вызове сервиса авторизации

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.business.account.management
Allow access to Busines Account Management API
redirect_uri
Required in formData
string

Redirect URI

client_idn
Required in formData
string

БИН/ИИН клиента

lang
Optional in formData
string

Язык интерфейса (default: ru)

scope
Optional in formData
string

Область видимости (default: oapi.business.account.api)

Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

{
    "schema": {
        "type": "object",
        "properties": {
            "authUrl": {
                "type": "string",
                "example": "https:\/\/base-url.kz\/auth\/realms\/realm\/protocol\/openid-connect\/auth?response_type=code&client_id=test-client-id&redirect_uri=https:\/\/myapp.com\/callback&client_type=bcc-business&client_idn=011110001110&lang=ru"
            }
        }
    }
}
400

Bad Request.

{
    "schema": {
        "type": "object",
        "properties": {
            "error": {
                "type": "string",
                "example": "invalid_request"
            },
            "error_description": {
                "type": "string",
                "example": "Some description about the error."
            }
        }
    }
}
401

Unauthorized.

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/auth-client/generate-auth-url
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/auth-client/generate-auth-url
content-type
accept
redirect_uri
client_idn
lang
scope

/escrow/ticket

get /escrow/ticket
Authorization
Authorization
(oauth2 application)

Токен аутентификации, полученный при вызове сервиса авторизации

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.business.account.management
Allow access to Busines Account Management API
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/auth-client/escrow/ticket
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/auth-client/escrow/ticket
accept

/escrow/sign-in

post /escrow/sign-in
Authorization
Authorization
(oauth2 application)

Токен аутентификации, полученный при вызове сервиса авторизации

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.business.account.management
Allow access to Busines Account Management API
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/auth-client/escrow/sign-in
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/auth-client/escrow/sign-in
accept