EDS_SCANDOC_DOWNLOAD API

EDS_SCANDOC_DOWNLOAD API 1.0.0

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

/send

post /send

Сервис скачивания сканированных документов в подсистеме ЕХЭД

Authorization
Authorization
(oauth2 application)

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

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.govtech.api
Allow access to Goventment Services API
RequestBody
Required in body
object
RequestDto
xib-trace-id
Required in header
string

Уникальный идентификатор запроса

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

200 OK

ResponseDto
400

Validation errors

FailureResponse
404

Not Found

FailureResponse
500

Different errors

FailureResponse
Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/eds-scandoc-download/send
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/eds-scandoc-download/send
content-type
accept
xib-trace-id

Definitions 

{
    "type": "object",
    "properties": {
        "timestamp": {
            "type": "string",
            "format": "date-time"
        },
        "error": {
            "type": "string"
        },
        "violations": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/Violation"
            }
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}
              
{
    "title": "Данные запроса на загрузку документа",
    "required": [
        "id",
        "idn"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Идентификатор"
        },
        "version": {
            "type": "integer",
            "description": "Версия документа",
            "format": "int32"
        },
        "idn": {
            "type": "string"
        }
    }
}

Статус

{
    "title": "Статус",
    "type": "object",
    "properties": {
        "code": {
            "type": "string",
            "description": "Код статуса"
        },
        "status": {
            "type": "string",
            "description": "Текст статуса"
        },
        "message": {
            "type": "string",
            "description": "Детальное сообщение"
        }
    }
}
              
{
    "title": "Результат",
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#\/definitions\/ProcessStatusDto"
        },
        "content": {
            "type": "array",
            "description": "Контент",
            "items": {
                "type": "string",
                "description": "Контент",
                "format": "byte"
            }
        }
    }
}