EDS_SCANDOC_UPLOAD API

EDS_SCANDOC_UPLOAD 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-upload/send
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/eds-scandoc-upload/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": [
        "accessType",
        "userId"
    ],
    "type": "object",
    "properties": {
        "userId": {
            "type": "string",
            "description": "Идентификатор пользователя"
        },
        "accessType": {
            "type": "string",
            "description": "Тип доступа пользователя",
            "enum": [
                "READ_ONLY",
                "EDIT",
                "OWNER"
            ]
        },
        "expirationDateTime": {
            "type": "string",
            "description": "Дата и время окончания действия доступа",
            "format": "date-time"
        },
        "expirationTimeout": {
            "type": "integer",
            "description": "Время в миллисекундах, по истечении которого доступ будет закрыт",
            "format": "int64"
        }
    }
}

Файлы, загружаемые в модуль сканированных документов

{
    "title": "Содержимое файла и его порядковый номер; порядковый номер используется, если загружается набор изображений",
    "required": [
        "content"
    ],
    "type": "object",
    "properties": {
        "orderNum": {
            "title": "Порядковый номер, для сортировки",
            "type": "integer",
            "format": "int32"
        },
        "content": {
            "type": "array",
            "items": {
                "type": "string",
                "format": "byte"
            }
        }
    }
}

Мета информация документа. Код метаинформации сохраняется в Property.key

{
    "title": "Свойства",
    "type": "object",
    "properties": {
        "properties": {
            "type": "array",
            "description": "Элементы",
            "items": {
                "$ref": "#\/definitions\/PropertyDto"
            }
        }
    }
}

Элементы

{
    "title": "Свойство",
    "required": [
        "key",
        "value"
    ],
    "type": "object",
    "properties": {
        "key": {
            "type": "string",
            "description": "Ключ"
        },
        "value": {
            "type": "string",
            "description": "Значение"
        }
    }
}
              
{
    "title": "Данные запроса на загрузку документа",
    "required": [
        "documentType",
        "files",
        "uploadType",
        "userId"
    ],
    "type": "object",
    "properties": {
        "userId": {
            "type": "string",
            "description": "Идентификатор пользователя, осуществляющего операцию"
        },
        "documentId": {
            "type": "string",
            "description": "Идентификатор документа - заполняется, если загружается новая версия существующего документа"
        },
        "files": {
            "type": "array",
            "description": "Файлы, загружаемые в модуль сканированных документов",
            "items": {
                "$ref": "#\/definitions\/FileInfoDto"
            }
        },
        "documentName": {
            "type": "string",
            "description": "Название документа"
        },
        "documentType": {
            "type": "string",
            "description": "Код типа документа"
        },
        "meta": {
            "$ref": "#\/definitions\/PropertiesDto"
        },
        "categories": {
            "type": "array",
            "description": "Коды категорий документа",
            "items": {
                "type": "string",
                "description": "Коды категорий документа"
            }
        },
        "userInfos": {
            "type": "array",
            "description": "Информация о пользователях",
            "items": {
                "$ref": "#\/definitions\/DocumentUserInfoDto"
            }
        },
        "uploadType": {
            "type": "string",
            "description": "Тип загрузки:\nSINGLE - один файл любого типа\nPICTURES - несколько изображений формата \"bmp\", \"jpeg\", \"png\", \"gif\"; при загрузке склеиваются в pdf-файл",
            "enum": [
                "SINGLE",
                "PICTURES"
            ]
        }
    }
}

Статус процесса

{
    "title": "Статус",
    "type": "object",
    "properties": {
        "code": {
            "type": "string",
            "description": "Код статуса"
        },
        "status": {
            "type": "string",
            "description": "Текст статуса"
        },
        "message": {
            "type": "string",
            "description": "Детальное сообщение"
        }
    }
}
              
{
    "title": "Результат загрузки документа",
    "type": "object",
    "properties": {
        "processStatus": {
            "$ref": "#\/definitions\/ProcessStatusDto"
        },
        "documentId": {
            "type": "string",
            "description": "Идентификатор документа"
        }
    }
}