Authorization API

Authorization API 2.1.0

0
Голосов пока нет

Сервисы для аутентификации приложений использующих API

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

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

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-sandbox.bcc.kz/bcc/production

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

Пути

/token

post /token

Получение токена доступа

Получение токена доступа

Authorization
Authorization
(basic)

Basic авторизация с использованием clientId и clientSecret

grant_type
Required in formData
string

Тип доступа (пример: client_credentials)

{
    "enum": [
        "authorization_code",
        "password",
        "client_credentials",
        "refresh_token"
    ]
}
scope
Required in formData
string

Запрошенный доступ

Content-Type
Опционально в header
string
application/x-www-form-urlencoded
Accept
Опционально в header
string
application/json
200

Успешное выполнение запроса

AccessTokenResponse
400

Ошибка в запросе

Пример запроса
Пример ответа
POST https://api-test.bcc.kz/bcc/production/v2/oauth/token
Попробуйте выполнить эту операцию
https://api-test.bcc.kz/bcc/production/v2/oauth/token
content-type
accept
grant_type
scope

/introspect

post /introspect

Проверка токена доступа

Проверка токена доступа

Authorization
Authorization
(basic)

Basic авторизация с использованием clientId и clientSecret

token
Required in formData
string

Токен

token_type_hint
Required in formData
string

Тип токена (пример: access_token)

Content-Type
Опционально в header
string
application/x-www-form-urlencoded
Accept
Опционально в header
string
application/json
200

Успешное выполнение запроса

IntrospectResponse
401

Ошибка в запросе

Пример запроса
Пример ответа
POST https://api-test.bcc.kz/bcc/production/v2/oauth/introspect
Попробуйте выполнить эту операцию
https://api-test.bcc.kz/bcc/production/v2/oauth/introspect
content-type
accept
token
token_type_hint

Определения

Информация о выданном токене доступа

{
    "type": "object",
    "additionalProperties": false,
    "required": [
        "token_type",
        "access_token",
        "expires_in",
        "scope",
        "consented_on"
    ],
    "properties": {
        "token_type": {
            "enum": [
                "bearer"
            ],
            "description": "Тип токена",
            "type": "string",
            "example": "bearer"
        },
        "access_token": {
            "type": "string",
            "description": "Токен доступа",
            "example": "token"
        },
        "expires_in": {
            "type": "integer",
            "description": "Длительность жизни токена (в секундах)",
            "format": "int64",
            "example": "3600"
        },
        "scope": {
            "type": "string",
            "description": "Одобренные доступы на ресурсы и\/или операции",
            "example": "scope"
        },
        "consented_on": {
            "type": "integer",
            "description": "Время выдачи токена",
            "format": "int32",
            "example": "1626944681"
        }
    }
}

Информация о токене

{
    "type": "object",
    "additionalProperties": false,
    "required": [
        "active",
        "client_id",
        "client_name",
        "username",
        "sub",
        "exp",
        "expstr",
        "iat",
        "nbf",
        "nbfstr",
        "scope",
        "token_type",
        "grant_type",
        "consented_on_str",
        "consented_on",
        "miscinfo"
    ],
    "properties": {
        "active": {
            "type": "boolean",
            "description": "Признак валидности",
            "example": "true"
        },
        "client_id": {
            "type": "string",
            "description": "Идентификатор приложения",
            "example": "5edd60a0-1368-4db6-bdce-c38f03c685f1"
        },
        "client_name": {
            "type": "string",
            "description": "Название приложения",
            "example": "App"
        },
        "username": {
            "type": "string",
            "description": "Идентификатор приложения",
            "example": "5edd60a0-1368-4db6-bdce-c38f03c685f1"
        },
        "sub": {
            "type": "string",
            "description": "Идентификатор приложения",
            "example": "5edd60a0-1368-4db6-bdce-c38f03c685f1"
        },
        "exp": {
            "type": "integer",
            "description": "Дата и время истечения срока валидности токена",
            "format": "int64",
            "example": "1626948281"
        },
        "expstr": {
            "type": "string",
            "description": "Дата и время истечения срока валидности токена",
            "example": "2021-07-22T10:04:41Z"
        },
        "iat": {
            "type": "integer",
            "description": "Дата и время выдачи токена",
            "format": "int64",
            "example": "1626948281"
        },
        "nbf": {
            "type": "integer",
            "description": "Дата и время выдачи токена",
            "format": "int64",
            "example": "1626948281"
        },
        "nbfstr": {
            "type": "string",
            "description": "Дата и время выдачи токена",
            "example": "2021-07-22T09:04:41Z"
        },
        "scope": {
            "type": "string",
            "description": "Доступы (через пробелы)",
            "example": "scope"
        },
        "miscinfo": {
            "type": "string",
            "example": ""
        },
        "consented_on": {
            "type": "integer",
            "description": "Дата и время выдачи токена",
            "format": "int64",
            "example": "1626944681"
        },
        "consented_on_str": {
            "type": "string",
            "description": "Дата и время выдачи токена",
            "example": "2021-07-22T09:04:41Z"
        },
        "grant_type": {
            "type": "string",
            "description": "Тип доступа",
            "example": "application"
        },
        "token_type": {
            "type": "string",
            "description": "Тип токена",
            "example": "bearer"
        }
    }
}