Возможные статусы документов:
1 Черновик
2 Ознакомление второй стороной
3 Контрагент не согласен с ознакомлением
4 Контрагент ознакомлен. Подписание владельцем
5 На подписи у второй стороны
6 Подписан обоюдно
7 Не подписан второй стороной
8 Отправлен на уведомление второй стороне
9 Вторая сторона уведомлена
Возможные типы процесса отправки документа:
1 Отправить как уведомление
2 Отправить на подпись
3 Загрузить черновик
______________________________________________________
Авторизация
Запрос POST
https://test.papka.kz/api/app/v1/proc/login
Тело запроса:
{
“username”: “Login”,
“password”:”Password”
}
Ответ
{
“status”: true,
“msg”: “Login successfull”,
“body”: {
“id”: 135,
“name”: “”,
“iin”: “”,
“email”: “”,
“token”: “eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI4NDAzMzAzMDA0NTUiLCJleHAiOjE2MTQzNTk3NzQsImlhdCI6MTYxNDM0MTc3NCwianRpIjoiMTM1In0.uMyrsqk5QTO9UqQSuz_Fe1rm4fo5vpf3XT1Q3Kcgh86HuImC5SlB28GE3O3gZVoCXkDl3cpfZrJqS60N6x2CJg”
}
}
Где token это ключ для дальнейшей авторизации для запросов
Ошибка
{
“status”: false,
“msg”: “Invalid Credentials”,
“body”: null
}
______________________________________________________
Создание нового исходящего документа
Запрос POST
https://test.papka.kz/api/app/v1/proc/addDocument
Тело запроса:
{
“senderBiin”: “”,
“documentDescription”: “Реализация ТМЗ и услуг ТДЛ00000013 от 28.03.2011 12:00:00”,
“contragentBiin”: “201140031700”,
“contragentEmail”: “”,
“files”: [
{
“originalFile”: {
“name”: “Реализация ТМЗ и услуг ТДЛ00000013 от 28.03.2011 12:00:00.pdf”,
“mime”: “application/pdf”,
“extension”: “pdf”,
“base64Data”: “”
},
“signedFile”: {
“name”: “Реализация ТМЗ и услуг ТДЛ00000013 от 28.03.2011 12:00:00.cms”,
“mime”: “application/vnd.openxmlformats-officedocument.wordprocessingml.document”,
“extension”: “cms”,
“base64Data”: “”
}
}
],
“processType”: 2
}
Авторизация Bearer Токен полученный при авторизации
Ответ:
{“status”:true,”msg”:”Document successfuly created”,”body”:{“documentId”:697}}
______________________________________________________
Получение статуса документа
Запрос GET
https://test.papka.kz/api/app/v1/proc/getDocStatus
Тело запроса:
{}
Параметры запроса:
docId=697
Авторизация Bearer Токен полученный при авторизации
Ответ:
{“status”:true,”msg”:null,”body”:{“docId”:697,”statusId”:5,”statusName”:”На подписи у второй стороны”}}
______________________________________________________
Получение данных документа
Запрос GET
https://test.papka.kz/api/app/v1/proc/getDoc
Тело запроса:
{}
Параметры запроса:
docId=697
Авторизация Bearer Токен полученный при авторизации
Ответ:
{
“status”: true,
“msg”: null,
“body”: {
“documentId”: 697,
“docNumber”: “10674”,
“status”: {
“id”: 5,
“createdAt”: null,
“name”: “На подписи у второй стороны”,
“color”: “#0085ad”,
“updatedAt”: null
},
“docFrom”: {
“id”: 177,
“adress”: null,
“biin”: “”,
“ceo”: “”,
“createdAt”: “2021-03-11T11:40:14.000+0000”,
“name”: “”,
“updatedAt”: “2021-03-11T11:40:14.000+0000”,
“shortName”: “”,
“ul”: false
},
“docTo”: [
{
“id”: 176,
“adress”: “”,
“biin”: “”,
“ceo”: “”,
“createdAt”: “2021-03-11T11:40:14.000+0000”,
“name”: “ТОО \”PAPKA.KZ\””,
“updatedAt”: “2021-03-11T11:40:14.000+0000”,
“shortName”: “ТОО \”PAPKA.KZ\””,
“ul”: true
}
],
“files”: [
{
“docFileId”: 347,
“files”: [
{
“id”: 1847,
“createdAt”: “2021-03-11T14:27:03.000+0000”,
“ext”: “pdf”,
“mime”: “application/pdf”,
“name”: “Реализация ТМЗ и услуг ТДЛ00000013 от 28.03.2011 12:00:00.pdf”,
“path”: “697/orig/3ea9588c-694e-4547-b403-cc8e089e9040”,
“size”: 57903,
“updatedAt”: “2021-03-11T14:27:03.000+0000”,
“userId”: 153,
“signed”: false,
“signInfoList”: null,
“view”: false,
“base64Data”: ” “
},
{
“id”: 1848,
“createdAt”: “2021-03-11T14:27:04.000+0000”,
“ext”: “cms”,
“mime”: “application/pdf”,
“name”: “Реализация ТМЗ и услуг ТДЛ00000013 от 28.03.2011 12:00:00.cms”,
“path”: “697/signed/4c628a53-9451-4cb8-aa57-53a645d1d647”,
“size”: 62654,
“updatedAt”: “2021-03-11T14:27:04.000+0000”,
“userId”: 153,
“signed”: true,
“signInfoList”: [
{
“name”: “”,
“signTime”: “2021-03-11T14:13:15.000+0000”
}
],
“view”: false,
“base64Data”: “”
},
{
“id”: 1849,
“createdAt”: “2021-03-11T14:27:05.000+0000”,
“ext”: “pdf”,
“mime”: “application/pdf”,
“name”: “Реализация ТМЗ и услуг ТДЛ00000013 от 28.03.2011 12:00:00.pdf”,
“path”: “697/signed/cae9bbcd-bf3e-4b83-bc56-cf41e973ba97”,
“size”: 88422,
“updatedAt”: “2021-03-11T14:27:05.000+0000”,
“userId”: 153,
“signed”: true,
“signInfoList”: null,
“view”: true,
“base64Data”: “”
}
],
“statusId”: 5
}
],
“accessRights”: {
“file”: {
“uploadFile”: false,
“deleteFile”: false,
“downloadFile”: true
},
“buttons”: [
{
“id”: 8,
“name”: “Завершить подписание”,
“newStatusValue”: 6,
“forSign”: true,
“fileId”: null,
“child”: null
}
]
},
“title”: “Реализация ТМЗ и услуг ТДЛ00000013 от 28.03.2011 12:00:00”
}
}
______________________________________________________
Получение списка документов
Запрос GET
https://test.papka.kz/api/app/v1/proc/getDocuments
Тело запроса:
{}
Параметры запроса:
type= in или out
biin= Бин Органиазции
Авторизация Bearer Токен полученный при авторизации
Ответ:
{“status”:true,”
msg”:null,”
body”:[{“
docId”:697,”
docNum”:”10674″,”
docDate”:”2021-03-11T14:27:02.000+0000″,”
status”:{“
id”:5,”
name”:”На подписи у второй стороны”,”
color”:”#0085ad”
},
“file”:[{
“name”:”Реализация ТМЗ и услуг ТДЛ00000013 от 28.03.2011 12:00:00.pdf”,
“extension”:”pdf”,
“base64Data”:null,
“mime”:null}],
“sender”:{
“id”:177,
“name”:””,”
bin”:””},
“reciever”:[{
“id”:176,
“name”:”ТОО \”PAPKA.KZ\””,
“bin”:””}],
“title”:”Реализация ТМЗ и услуг ТДЛ00000013 от 28.03.2011 12:00:00″}]}
______________________________________________________
Изменение документа
Запрос POST
https://test.papka.kz/api/app/v1/proc/changeDoc
Тело запроса:
{
“docId”: 697,
“oldStatus”: 5, //Старый статус
“newStatus”: 6, //Новый статус
“signedFiles”: [
{
“docFileId”: 347,
“base64Data”: “”
}
]
}
Авторизация Bearer Токен полученный при авторизации
Ответ:
{“status”:true,
“msg”:null,
“body”:{“id”:697,
“createdAt”:”2021-03-11T14:27:02.000+0000″,
“docnumber”:”10674″,
“updatedAt”:”2021-03-11T14:27:02.000+0000″,
“statusId”:6,
“contractorId”:177,
“userId”:153,”title”:”Реализация ТМЗ и услуг ТДЛ00000013 от 28.03.2011 12:00:00″,
“uuid”:”2f5ddea1-9db0-4df6-8dbb-2ff8bdf274c7″}}