Back to top

Рокет Ворк | API

Intro

Рокет Ворк — облачная платформа для быстрой и удобной работы с самозанятыми поставщиками услуг. Далее мы описали API, которое поможет интегрироваться с платформой.

Терминология

Для начала объясним несколько терминов, которые встретите далее:

  • Исполнитель (или Самозанятый) — физическое лицо, работающее на основании Федерального закона и являющееся клиентом платформы

  • Задача — запрос на оказание услуг, доступный для акцепта либо неограниченному, либо ограниченному либо ограниченному кругу исполнителей (в том числе, единственным исполнителем).

  • Компания — компания-клиент платформы, которая выступает заказчиком услуг самозанятых.

  • Сервис (или Платформа) —программный продукт Рокет Ворк.

  • Профиль — учетные данные компании.

Задачи и договоры

Задачи

Задачи — это готовые к заключению и/или заключенные договоры об оказании услуг с самозанятыми-исполнителями. Компания, работающая с самозанятыми по такой системе через Рокет Ворк, может:

  • создавать задачи;

  • изменять уже созданные задачи:

    • передавать в работу исполнителю;
    • подтверждать полное и корректное выполнение задачи;
  • поручать оплату по выполненной задаче;

  • получать информацию о существующей задаче.

Сама задача с точки зрения API является ресурсом со следующими полями:

  • id — уникальный идентификатор;

  • agreement_signing_uri — ссылка для подписания договора исполнителем;

  • agreement_type_id — идентификатор шаблона договора;

  • agreement_uri — ссылка на договор с исполнителем;

  • category — категория (тип) задачи;

  • created_at — дата и время создания;

  • date — дата запланированного выполнения задачи;

  • description — описание задания;

  • execution_comment — комментарии по исполнению задания;

  • fee — предлагаемая стоимость исполнения (в рублях РФ);

  • metadata — дополнительные данные о задаче (например, номер договора, он он подписан на бумаге);

  • paid_at — дата и время оплаты задачи;

  • payment_errors — ошибки, которые возникли во время последней неудачной попытки оплаты по задаче;

  • receipt_uri — ссылка на чек на сайте nalog.ru

  • status — статус задания, один из:

    • draft— «Черновик» (задание создано, ожидает подписания);
    • inwork — «В работе»;
    • completed — «Выполнено» (работа выполнена исполнителем, задание готово к оплате);
    • paying — «Оплачивается»;
    • paid — «Оплачена»;
    • canceled — «Отменена»;
    • error — «Ошибка оплаты»;
  • title — название задачи;

  • executor — данные об исполнителе задания.

Применение

Создать задачу
POST/api/tasks

Example URI

POST /api/tasks
Request
HideShow

POST  /api/tasks

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjAsInRva2VuIjoiS1VLVVhOQSJ9.HNrJtcDsBaNm6n1yXmnew-QzHETDAzOFCWyzJitSxtO9Jl-DBx2ywEhQoqQT4g65RjY1jAy78f3dVJIFSMd81MZYQBVnZgh3ge9Pj_igHXwaH8hLZHFgmeRlM2nfacU1uhf71WrvWvaWQimHNmuvjTFIUM_HzFCrfuZ5ZcPXqzmRsm5XVD6Dg7NTOlpqjfREr3IEwiej7MT_fhNOBnA3DMFs-rl-aVUPRQzoInQqcJDyKAR40D2VzepgED6UEUt4aB4fLAQ3_-_qydSeY-DAqg9lMYqwFxTpi0EdB1rKJZoKax3QQAaBmeBMuRA2JJmBoS4WAhizYbxZ-dP9NVNPUQ
Content-Type: application/json
Body
{
  "category": "development",
  "date": "2021-06-08",
  "description": "Platform development",
  "executor": "+79032702708",
  "title": "Platform development",
  "fee": 2700,
  "metadata": {
    "test": "test"
  },
  "executor_inn": "1234567890"
}
Response  201
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "task": {
    "agreement_signing_uri": null,
    "agreement_type_id": 1970,
    "agreement_uri": "https://localhost:3000/api/tasks/2f5bd7f94462a6aae2f0a3deb2b3c58c19696a8e7514e7e19b2be42ddc4e6852/agreement",
    "category": "development",
    "created_at": "2021-06-08T17:43:40.917Z",
    "date": "2021-06-08",
    "description": "Platform development",
    "execution_comment": null,
    "fee": "2700.0",
    "id": 1773,
    "metadata": {
      "test": "test"
    },
    "paid_at": null,
    "payment_errors": [],
    "receipt_uri": null,
    "signed": false,
    "status": "draft",
    "title": "Platform development",
    "executor": {
      "id": 1835,
      "first_name": "Ксения",
      "last_name": "Белова",
      "inn": "1234567890",
      "phone": "+79032702708",
      "email": "karina@beier.biz",
      "second_name": "Денисовна",
      "status": "active"
    }
  }
}
Request
HideShow

POST  /api/tasks

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjAsInRva2VuIjoiS1VLVVhOQSJ9.HNrJtcDsBaNm6n1yXmnew-QzHETDAzOFCWyzJitSxtO9Jl-DBx2ywEhQoqQT4g65RjY1jAy78f3dVJIFSMd81MZYQBVnZgh3ge9Pj_igHXwaH8hLZHFgmeRlM2nfacU1uhf71WrvWvaWQimHNmuvjTFIUM_HzFCrfuZ5ZcPXqzmRsm5XVD6Dg7NTOlpqjfREr3IEwiej7MT_fhNOBnA3DMFs-rl-aVUPRQzoInQqcJDyKAR40D2VzepgED6UEUt4aB4fLAQ3_-_qydSeY-DAqg9lMYqwFxTpi0EdB1rKJZoKax3QQAaBmeBMuRA2JJmBoS4WAhizYbxZ-dP9NVNPUQ
Content-Type: application/json
Response  422
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "errors": [
    "Category can't be blank",
    "Date can't be blank",
    "Title can't be blank",
    "Description can't be blank"
  ]
}

Получить информацию о задаче
GET/api/tasks/{id}

Example URI

GET /api/tasks/1774
URI Parameters
HideShow
id
number (required) Example: 1774
Request
HideShow

GET  /api/tasks/1774

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjEsInRva2VuIjoiS1VLVVhOQSJ9.xXkArESPk3ODB_3bkkrJ9IkdGOty0e4_CsgNHw-pbX9o45YZG4PR49fAenUtRbY-RHhA5dHnw-p7i1rCn7UJMfw4nocjHcXoCGmH9OX5H92Iiks0q1n-spJxJog8LFhr6RoTpCH-WCHjWq1TtkiLfqEWHTHCqU3xXTYzYY1i0zOAzDRsic9pz9VYeJI_tlgj3AzrbN9jvd_EV9uHFDeaOSO32-hYVzpwa1EEJZeQrzDxOuJC8B9jZphWZ-d2uLEtS2yIA0M-3p15pMPm83Ei0Zuo23ckIGwqULLV3su8-kXGlf7merZz2v1UaOIf8lnQVRsboD2OXia2gu4rB4CD4w
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "task": {
    "agreement_signing_uri": null,
    "agreement_type_id": 1972,
    "agreement_uri": "https://localhost:3000/api/tasks/bdc995fa73f041961c0b2a725632820c6b8f52012bbc06e7062593a60986492f/agreement",
    "category": "Доставка ЕДЫ",
    "created_at": "2021-06-08T17:43:41.042Z",
    "date": "2021-06-08",
    "description": "Довезти заказ до клиента, не сожрав по дороге",
    "execution_comment": null,
    "fee": "100.0",
    "id": 1774,
    "metadata": {},
    "paid_at": null,
    "payment_errors": [],
    "receipt_uri": null,
    "signed": true,
    "status": "draft",
    "title": "Доставить ужин",
    "executor": {
      "id": 1837,
      "first_name": "Агриппина",
      "last_name": "Ковалева",
      "inn": "1234567890",
      "phone": "+79628326347",
      "email": "augusta.monahan@rau.us",
      "second_name": "Робертовна",
      "status": "active"
    }
  }
}

Отметить задачу как выполненную
PATCH/api/tasks/{id}/{event}

Example URI

PATCH /api/tasks/1775/complete
URI Parameters
HideShow
id
number (required) Example: 1775
event
string (required) Example: complete
Request
HideShow

PATCH  /api/tasks/1775/complete

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjEsInRva2VuIjoiS1VLVVhOQSJ9.xXkArESPk3ODB_3bkkrJ9IkdGOty0e4_CsgNHw-pbX9o45YZG4PR49fAenUtRbY-RHhA5dHnw-p7i1rCn7UJMfw4nocjHcXoCGmH9OX5H92Iiks0q1n-spJxJog8LFhr6RoTpCH-WCHjWq1TtkiLfqEWHTHCqU3xXTYzYY1i0zOAzDRsic9pz9VYeJI_tlgj3AzrbN9jvd_EV9uHFDeaOSO32-hYVzpwa1EEJZeQrzDxOuJC8B9jZphWZ-d2uLEtS2yIA0M-3p15pMPm83Ei0Zuo23ckIGwqULLV3su8-kXGlf7merZz2v1UaOIf8lnQVRsboD2OXia2gu4rB4CD4w
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "task": {
    "agreement_signing_uri": null,
    "agreement_type_id": 1973,
    "agreement_uri": "https://localhost:3000/api/tasks/1768e6b38e64e3cf341df74724a353ee2ac6fb81c5237ca7e6086a9d65789c5f/agreement",
    "category": "Доставка ЕДЫ",
    "created_at": "2021-06-08T17:43:41.102Z",
    "date": "2021-06-08",
    "description": "Довезти заказ до клиента, не сожрав по дороге",
    "execution_comment": null,
    "fee": "100.0",
    "id": 1775,
    "metadata": {},
    "paid_at": null,
    "payment_errors": [],
    "receipt_uri": null,
    "signed": true,
    "status": "completed",
    "title": "Доставить ужин",
    "executor": {
      "id": 1838,
      "first_name": "Анжела",
      "last_name": "Васильева",
      "inn": "1234567890",
      "phone": "+79286382539",
      "email": "barton_littel@schumm.co.uk",
      "second_name": "Георгиевна",
      "status": "active"
    }
  }
}

Отметить задачу как подписанную
PATCH/api/tasks/{id}/mark_as_signed

Example URI

PATCH /api/tasks/1776/mark_as_signed
URI Parameters
HideShow
id
number (required) Example: 1776
Request
HideShow

PATCH  /api/tasks/1776/mark_as_signed

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjEsInRva2VuIjoiS1VLVVhOQSJ9.xXkArESPk3ODB_3bkkrJ9IkdGOty0e4_CsgNHw-pbX9o45YZG4PR49fAenUtRbY-RHhA5dHnw-p7i1rCn7UJMfw4nocjHcXoCGmH9OX5H92Iiks0q1n-spJxJog8LFhr6RoTpCH-WCHjWq1TtkiLfqEWHTHCqU3xXTYzYY1i0zOAzDRsic9pz9VYeJI_tlgj3AzrbN9jvd_EV9uHFDeaOSO32-hYVzpwa1EEJZeQrzDxOuJC8B9jZphWZ-d2uLEtS2yIA0M-3p15pMPm83Ei0Zuo23ckIGwqULLV3su8-kXGlf7merZz2v1UaOIf8lnQVRsboD2OXia2gu4rB4CD4w
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "task": {
    "agreement_signing_uri": null,
    "agreement_type_id": 1974,
    "agreement_uri": "https://localhost:3000/api/tasks/0f25ed65ad563b7e43d9bcd218c39333e4b34eb49084e11d2e5ec61642ff6e69/agreement",
    "category": "Доставка ЕДЫ",
    "created_at": "2021-06-08T17:43:41.140Z",
    "date": "2021-06-08",
    "description": "Довезти заказ до клиента, не сожрав по дороге",
    "execution_comment": null,
    "fee": "100.0",
    "id": 1776,
    "metadata": {},
    "paid_at": null,
    "payment_errors": [],
    "receipt_uri": null,
    "signed": true,
    "status": "inwork",
    "title": "Доставить ужин",
    "executor": {
      "id": 1839,
      "first_name": "Ангелина",
      "last_name": "Лазарева",
      "inn": "1234567890",
      "phone": "+79635188911",
      "email": "vanda.hilpert@welchpfannerstill.co.uk",
      "second_name": "Геннадиевна",
      "status": "active"
    }
  }
}
Request
HideShow

PATCH  /api/tasks/1777/mark_as_signed

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjEsInRva2VuIjoiS1VLVVhOQSJ9.xXkArESPk3ODB_3bkkrJ9IkdGOty0e4_CsgNHw-pbX9o45YZG4PR49fAenUtRbY-RHhA5dHnw-p7i1rCn7UJMfw4nocjHcXoCGmH9OX5H92Iiks0q1n-spJxJog8LFhr6RoTpCH-WCHjWq1TtkiLfqEWHTHCqU3xXTYzYY1i0zOAzDRsic9pz9VYeJI_tlgj3AzrbN9jvd_EV9uHFDeaOSO32-hYVzpwa1EEJZeQrzDxOuJC8B9jZphWZ-d2uLEtS2yIA0M-3p15pMPm83Ei0Zuo23ckIGwqULLV3su8-kXGlf7merZz2v1UaOIf8lnQVRsboD2OXia2gu4rB4CD4w
Content-Type: application/json
Body
{
  "signed_at": "2021-01-12",
  "metadata": {
    "legal": {
      "id": "12345"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "task": {
    "agreement_signing_uri": null,
    "agreement_type_id": 1975,
    "agreement_uri": "https://localhost:3000/api/tasks/b43e3f985fc54d217d507cf6de675cb6cbe649258777e91a6d91590787175b92/agreement",
    "category": "Доставка ЕДЫ",
    "created_at": "2021-06-08T17:43:41.238Z",
    "date": "2021-06-08",
    "description": "Довезти заказ до клиента, не сожрав по дороге",
    "execution_comment": null,
    "fee": "100.0",
    "id": 1777,
    "metadata": {
      "legal": {
        "id": "12345"
      }
    },
    "paid_at": null,
    "payment_errors": [],
    "receipt_uri": null,
    "signed": true,
    "status": "inwork",
    "title": "Доставить ужин",
    "executor": {
      "id": 1840,
      "first_name": "Анфиса",
      "last_name": "Белоусова",
      "inn": "1234567890",
      "phone": "+79962918035",
      "email": "celinda@quigley.biz",
      "second_name": "Владиславовна",
      "status": "active"
    }
  }
}

Запустить процесс оплаты задачи
PATCH/api/tasks/{id}/pay

Example URI

PATCH /api/tasks/1778/pay
URI Parameters
HideShow
id
number (required) Example: 1778
Request
HideShow

PATCH  /api/tasks/1778/pay

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjEsInRva2VuIjoiS1VLVVhOQSJ9.xXkArESPk3ODB_3bkkrJ9IkdGOty0e4_CsgNHw-pbX9o45YZG4PR49fAenUtRbY-RHhA5dHnw-p7i1rCn7UJMfw4nocjHcXoCGmH9OX5H92Iiks0q1n-spJxJog8LFhr6RoTpCH-WCHjWq1TtkiLfqEWHTHCqU3xXTYzYY1i0zOAzDRsic9pz9VYeJI_tlgj3AzrbN9jvd_EV9uHFDeaOSO32-hYVzpwa1EEJZeQrzDxOuJC8B9jZphWZ-d2uLEtS2yIA0M-3p15pMPm83Ei0Zuo23ckIGwqULLV3su8-kXGlf7merZz2v1UaOIf8lnQVRsboD2OXia2gu4rB4CD4w
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "task": {
    "agreement_signing_uri": null,
    "agreement_type_id": 1976,
    "agreement_uri": "https://localhost:3000/api/tasks/d89037799a347a0b66aadeea3c95ef439e8e7d1a781f3465ed00f6faa8388ecd/agreement",
    "category": "Доставка ЕДЫ",
    "created_at": "2021-06-08T17:43:41.348Z",
    "date": "2021-06-08",
    "description": "Довезти заказ до клиента, не сожрав по дороге",
    "execution_comment": null,
    "fee": "100.0",
    "id": 1778,
    "metadata": {},
    "paid_at": null,
    "payment_errors": [],
    "receipt_uri": null,
    "signed": true,
    "status": "paying",
    "title": "Доставить ужин",
    "executor": {
      "id": 1841,
      "first_name": "Зинаида",
      "last_name": "Антонова",
      "inn": "1234567890",
      "phone": "+78217673410",
      "email": "kent@hansen.info",
      "second_name": "Матвеевна",
      "status": "active"
    }
  }
}
Request
HideShow

PATCH  /api/tasks/1779/pay

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjEsInRva2VuIjoiS1VLVVhOQSJ9.xXkArESPk3ODB_3bkkrJ9IkdGOty0e4_CsgNHw-pbX9o45YZG4PR49fAenUtRbY-RHhA5dHnw-p7i1rCn7UJMfw4nocjHcXoCGmH9OX5H92Iiks0q1n-spJxJog8LFhr6RoTpCH-WCHjWq1TtkiLfqEWHTHCqU3xXTYzYY1i0zOAzDRsic9pz9VYeJI_tlgj3AzrbN9jvd_EV9uHFDeaOSO32-hYVzpwa1EEJZeQrzDxOuJC8B9jZphWZ-d2uLEtS2yIA0M-3p15pMPm83Ei0Zuo23ckIGwqULLV3su8-kXGlf7merZz2v1UaOIf8lnQVRsboD2OXia2gu4rB4CD4w
Content-Type: application/json
Response  422
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "errors": [
    "Task in status inwork can't be paid"
  ]
}
Request
HideShow

PATCH  /api/tasks/1780/pay

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjEsInRva2VuIjoiS1VLVVhOQSJ9.xXkArESPk3ODB_3bkkrJ9IkdGOty0e4_CsgNHw-pbX9o45YZG4PR49fAenUtRbY-RHhA5dHnw-p7i1rCn7UJMfw4nocjHcXoCGmH9OX5H92Iiks0q1n-spJxJog8LFhr6RoTpCH-WCHjWq1TtkiLfqEWHTHCqU3xXTYzYY1i0zOAzDRsic9pz9VYeJI_tlgj3AzrbN9jvd_EV9uHFDeaOSO32-hYVzpwa1EEJZeQrzDxOuJC8B9jZphWZ-d2uLEtS2yIA0M-3p15pMPm83Ei0Zuo23ckIGwqULLV3su8-kXGlf7merZz2v1UaOIf8lnQVRsboD2OXia2gu4rB4CD4w
Content-Type: application/json
Response  422
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "errors": [
    "Task executor does not have available payment method"
  ]
}

Отменить задачу
PATCH/api/tasks/{id}/cancel

Example URI

PATCH /api/tasks/1781/cancel
URI Parameters
HideShow
id
number (required) Example: 1781
Request
HideShow

PATCH  /api/tasks/1781/cancel

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjEsInRva2VuIjoiS1VLVVhOQSJ9.xXkArESPk3ODB_3bkkrJ9IkdGOty0e4_CsgNHw-pbX9o45YZG4PR49fAenUtRbY-RHhA5dHnw-p7i1rCn7UJMfw4nocjHcXoCGmH9OX5H92Iiks0q1n-spJxJog8LFhr6RoTpCH-WCHjWq1TtkiLfqEWHTHCqU3xXTYzYY1i0zOAzDRsic9pz9VYeJI_tlgj3AzrbN9jvd_EV9uHFDeaOSO32-hYVzpwa1EEJZeQrzDxOuJC8B9jZphWZ-d2uLEtS2yIA0M-3p15pMPm83Ei0Zuo23ckIGwqULLV3su8-kXGlf7merZz2v1UaOIf8lnQVRsboD2OXia2gu4rB4CD4w
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "task": {
    "agreement_signing_uri": null,
    "agreement_type_id": 1979,
    "agreement_uri": "https://localhost:3000/api/tasks/b436470220c77a6941a2c5517b1bf5cfcdf467c27627280776ade473ae6df68a/agreement",
    "category": "Доставка ЕДЫ",
    "created_at": "2021-06-08T17:43:41.676Z",
    "date": "2021-06-08",
    "description": "Довезти заказ до клиента, не сожрав по дороге",
    "execution_comment": null,
    "fee": "100.0",
    "id": 1781,
    "metadata": {},
    "paid_at": null,
    "payment_errors": [],
    "receipt_uri": null,
    "signed": false,
    "status": "canceled",
    "title": "Доставить ужин",
    "executor": {
      "id": 1844,
      "first_name": "Наталья",
      "last_name": "Максимова",
      "inn": "1234567890",
      "phone": "+79154036164",
      "email": "vanna@okeefefarrell.co.uk",
      "second_name": "Ярославовна",
      "status": "active"
    }
  }
}
Request
HideShow

PATCH  /api/tasks/1782/cancel

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjEsInRva2VuIjoiS1VLVVhOQSJ9.xXkArESPk3ODB_3bkkrJ9IkdGOty0e4_CsgNHw-pbX9o45YZG4PR49fAenUtRbY-RHhA5dHnw-p7i1rCn7UJMfw4nocjHcXoCGmH9OX5H92Iiks0q1n-spJxJog8LFhr6RoTpCH-WCHjWq1TtkiLfqEWHTHCqU3xXTYzYY1i0zOAzDRsic9pz9VYeJI_tlgj3AzrbN9jvd_EV9uHFDeaOSO32-hYVzpwa1EEJZeQrzDxOuJC8B9jZphWZ-d2uLEtS2yIA0M-3p15pMPm83Ei0Zuo23ckIGwqULLV3su8-kXGlf7merZz2v1UaOIf8lnQVRsboD2OXia2gu4rB4CD4w
Content-Type: application/json
Response  422
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "errors": [
    "Task in status inwork can't become canceled"
  ]
}

Получение данных об исполнителе по номеру телефона

Исполнители

При необходимости можно получить данные о самозанятом или зарегистрировать его:

  • first_name — имя

  • second_name — отчество

  • last_name — фамилия

  • phone — номер телефона

  • selfemployed_status — статус самозанятости

  • inn — ИНН самозанятого

  • payment_info - данные о счете самозанятого

    • bank_account - данные о банковском счете
      • bic - Бик банка
      • account_number - номер счета
    • card_number - номер карты

Применение

Завести исполнителя с переданными данными
POST/api/executors

Example URI

POST /api/executors
Request
HideShow

POST  /api/executors

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjAsInRva2VuIjoiS1VLVVhOQSJ9.HNrJtcDsBaNm6n1yXmnew-QzHETDAzOFCWyzJitSxtO9Jl-DBx2ywEhQoqQT4g65RjY1jAy78f3dVJIFSMd81MZYQBVnZgh3ge9Pj_igHXwaH8hLZHFgmeRlM2nfacU1uhf71WrvWvaWQimHNmuvjTFIUM_HzFCrfuZ5ZcPXqzmRsm5XVD6Dg7NTOlpqjfREr3IEwiej7MT_fhNOBnA3DMFs-rl-aVUPRQzoInQqcJDyKAR40D2VzepgED6UEUt4aB4fLAQ3_-_qydSeY-DAqg9lMYqwFxTpi0EdB1rKJZoKax3QQAaBmeBMuRA2JJmBoS4WAhizYbxZ-dP9NVNPUQ
Content-Type: application/json
Body
{
  "executor": {
    "inn": "12312312311",
    "phone": "+79153271212",
    "first_name": "Test",
    "last_name": "Last Name Test",
    "second_name": "Secod Name Test",
    "payment_info": {
      "bank_account": {
        "bic": "31321312321",
        "account_number": "13231231"
      },
      "card_number": "13123213123"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "executor": {
    "id": 1831,
    "first_name": "Test",
    "second_name": "Secod Name Test",
    "last_name": "Last Name Test",
    "phone": "+79153271212",
    "email": "",
    "status": "draft",
    "inn": "12312312311",
    "selfemployed_status": "unknown",
    "passport_series": "",
    "passport_number": "",
    "passport_issued_at": null,
    "passport_issued_by_name": "",
    "passport_issued_by_code": "",
    "payment_info": {
      "card_number": "13123213123",
      "bank_account": {
        "bic": "31321312321",
        "account_number": "13231231"
      }
    },
    "selfemployed": false
  }
}

Обновить данные исполнителя
PATCH/api/executors/+79151846547

Example URI

PATCH /api/executors/+79151846547
URI Parameters
HideShow
id
string (required) Example: %2B79151846547
Request
HideShow

PATCH  /api/executors/ 79151846547

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjAsInRva2VuIjoiS1VLVVhOQSJ9.HNrJtcDsBaNm6n1yXmnew-QzHETDAzOFCWyzJitSxtO9Jl-DBx2ywEhQoqQT4g65RjY1jAy78f3dVJIFSMd81MZYQBVnZgh3ge9Pj_igHXwaH8hLZHFgmeRlM2nfacU1uhf71WrvWvaWQimHNmuvjTFIUM_HzFCrfuZ5ZcPXqzmRsm5XVD6Dg7NTOlpqjfREr3IEwiej7MT_fhNOBnA3DMFs-rl-aVUPRQzoInQqcJDyKAR40D2VzepgED6UEUt4aB4fLAQ3_-_qydSeY-DAqg9lMYqwFxTpi0EdB1rKJZoKax3QQAaBmeBMuRA2JJmBoS4WAhizYbxZ-dP9NVNPUQ
Content-Type: application/json
Body
{
  "executor": {
    "inn": "12312312311",
    "phone": "+79153271212",
    "first_name": "Test",
    "last_name": "Last Name Test",
    "second_name": "Secod Name Test",
    "payment_info": {
      "bank_account": {
        "bic": "31321312321",
        "account_number": "13231231"
      },
      "card_number": "13123213123"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "executor": {
    "id": 1832,
    "first_name": "Test",
    "second_name": "Secod Name Test",
    "last_name": "Last Name Test",
    "phone": "+79153271212",
    "email": "gabriela.langosh@wisozk.biz",
    "status": "active",
    "inn": "12312312311",
    "selfemployed_status": "validated",
    "selfemployed": true
  }
}

Получить данные исполнителя
GET/api/executors/+79151846547

Example URI

GET /api/executors/+79151846547
URI Parameters
HideShow
id
string (required) Example: %2B79151846547
Request
HideShow

GET  /api/executors/ 79151846547

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjAsInRva2VuIjoiS1VLVVhOQSJ9.HNrJtcDsBaNm6n1yXmnew-QzHETDAzOFCWyzJitSxtO9Jl-DBx2ywEhQoqQT4g65RjY1jAy78f3dVJIFSMd81MZYQBVnZgh3ge9Pj_igHXwaH8hLZHFgmeRlM2nfacU1uhf71WrvWvaWQimHNmuvjTFIUM_HzFCrfuZ5ZcPXqzmRsm5XVD6Dg7NTOlpqjfREr3IEwiej7MT_fhNOBnA3DMFs-rl-aVUPRQzoInQqcJDyKAR40D2VzepgED6UEUt4aB4fLAQ3_-_qydSeY-DAqg9lMYqwFxTpi0EdB1rKJZoKax3QQAaBmeBMuRA2JJmBoS4WAhizYbxZ-dP9NVNPUQ
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "executor": {
    "id": 1833,
    "first_name": "Алла",
    "second_name": "Фелuксовна",
    "last_name": "Козлова",
    "phone": "+79151846547",
    "email": "macie_pollich@blickkihn.com",
    "status": "active",
    "inn": "1234567890",
    "selfemployed_status": "validated",
    "selfemployed": true
  }
}
Request
HideShow

GET  /api/executors/79101230000

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjAsInRva2VuIjoiS1VLVVhOQSJ9.HNrJtcDsBaNm6n1yXmnew-QzHETDAzOFCWyzJitSxtO9Jl-DBx2ywEhQoqQT4g65RjY1jAy78f3dVJIFSMd81MZYQBVnZgh3ge9Pj_igHXwaH8hLZHFgmeRlM2nfacU1uhf71WrvWvaWQimHNmuvjTFIUM_HzFCrfuZ5ZcPXqzmRsm5XVD6Dg7NTOlpqjfREr3IEwiej7MT_fhNOBnA3DMFs-rl-aVUPRQzoInQqcJDyKAR40D2VzepgED6UEUt4aB4fLAQ3_-_qydSeY-DAqg9lMYqwFxTpi0EdB1rKJZoKax3QQAaBmeBMuRA2JJmBoS4WAhizYbxZ-dP9NVNPUQ
Content-Type: application/json
Response  404
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "errors": [
    "Executor not found"
  ]
}

Постбэки об изменениях задач и Подписки

Подписки

Для более эффективной работы данные о задачах должны быть всегда актуальными. Для этого мы сделали Подписки и Постбэки. Этот вариант показался нам проще и удобнее, потому что работает лучше и быстрее, чем постоянные запросы GET /api/tasks/{id}. Они не подходят для таких ситуаций, так как объем передаваемых данных значителен, из-за чего создаются необоснованные нагрузки на сеть и сервера.

Для решения этой проблемы можно попросить платформу отправлять запросы на определенные URI в случае изменений данных каких-либо задач. Такой запрос называется «постбэком», а «просьба» к платформе о совершении постбэков — «подпиской».

Постбэки

Логика постбэков заключается в обыкновенных GET и/или POST запросах с таким же телом, как и в ответе на GET/api/tasks/{id}. Отсюда вывод: постбэки способны заменить GET и POST при синхронизации или актуализации данных.

Обратите внимание, даже GET запросы будут иметь тело запроса. Подобное может не поддерживаться некоторыми веб-серверами.

Чтобы проблем не возникло, рекомендуем использовать POST-постбэки во всех ситуациях.

Подпиcки

Подписки на постбэки представляют собой указание платформе отправлять запросы при кажом изменении любой из принадлежащих заказчику задач на указанный в подписке URI. Иначе говоря: подписки на постбэки — это трекинг изменений в ваших задачах.

Подписки имеют следующие атрибуты:

  • id — уникальный идентификатор подписки;

  • uri — эндпоинт, на который будут отправляться запросы с информацией о задаче;

  • http_method — HTTP-метод данных запросов.

  • subscribed_on - Вид события, на которое идет подписка. Доступные виды:

    • executor.selfemployed_status - Подписаться на обновление статуса самозанятости

Виды событий. Payload.

executor.selfemployed_status

Отправляется в момент подтверждения статуса самозанятости

Payload:

{
  "inn":"1231412412",
  "phone":"+79153277121",
  "first_name":"Ivan",
  "last_name":"Ivanov"
  "selfemployed_status": "validated"
}

Применение

Получить список подписок
GET/api/postback_subscriptions

Example URI

GET /api/postback_subscriptions
Request
HideShow

GET  /api/postback_subscriptions

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjAsInRva2VuIjoiS1VLVVhOQSJ9.HNrJtcDsBaNm6n1yXmnew-QzHETDAzOFCWyzJitSxtO9Jl-DBx2ywEhQoqQT4g65RjY1jAy78f3dVJIFSMd81MZYQBVnZgh3ge9Pj_igHXwaH8hLZHFgmeRlM2nfacU1uhf71WrvWvaWQimHNmuvjTFIUM_HzFCrfuZ5ZcPXqzmRsm5XVD6Dg7NTOlpqjfREr3IEwiej7MT_fhNOBnA3DMFs-rl-aVUPRQzoInQqcJDyKAR40D2VzepgED6UEUt4aB4fLAQ3_-_qydSeY-DAqg9lMYqwFxTpi0EdB1rKJZoKax3QQAaBmeBMuRA2JJmBoS4WAhizYbxZ-dP9NVNPUQ
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
[
  {
    "postback_subscription": {
      "id": 102,
      "http_method": "post",
      "uri": "http://nitzsche.com"
    }
  },
  {
    "postback_subscription": {
      "id": 103,
      "http_method": "post",
      "uri": "http://tillman.ca"
    }
  }
]

Оформить подписку
POST/api/postback_subscriptions

Example URI

POST /api/postback_subscriptions
Request
HideShow

POST  /api/postback_subscriptions

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjAsInRva2VuIjoiS1VLVVhOQSJ9.HNrJtcDsBaNm6n1yXmnew-QzHETDAzOFCWyzJitSxtO9Jl-DBx2ywEhQoqQT4g65RjY1jAy78f3dVJIFSMd81MZYQBVnZgh3ge9Pj_igHXwaH8hLZHFgmeRlM2nfacU1uhf71WrvWvaWQimHNmuvjTFIUM_HzFCrfuZ5ZcPXqzmRsm5XVD6Dg7NTOlpqjfREr3IEwiej7MT_fhNOBnA3DMFs-rl-aVUPRQzoInQqcJDyKAR40D2VzepgED6UEUt4aB4fLAQ3_-_qydSeY-DAqg9lMYqwFxTpi0EdB1rKJZoKax3QQAaBmeBMuRA2JJmBoS4WAhizYbxZ-dP9NVNPUQ
Content-Type: application/json
Body
{
  "http_method": "get",
  "uri": "http://example.com",
  "subscribed_on": [
    "tasks",
    "selfemployed_status"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "postback_subscription": {
    "id": 104,
    "http_method": "get",
    "uri": "http://example.com"
  }
}

Отменить подписку
DELETE/api/postback_subscriptions/{id}

Example URI

DELETE /api/postback_subscriptions/105
URI Parameters
HideShow
id
number (required) Example: 105
Request
HideShow

DELETE  /api/postback_subscriptions/105

Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjMxNzQyMjAsInRva2VuIjoiS1VLVVhOQSJ9.HNrJtcDsBaNm6n1yXmnew-QzHETDAzOFCWyzJitSxtO9Jl-DBx2ywEhQoqQT4g65RjY1jAy78f3dVJIFSMd81MZYQBVnZgh3ge9Pj_igHXwaH8hLZHFgmeRlM2nfacU1uhf71WrvWvaWQimHNmuvjTFIUM_HzFCrfuZ5ZcPXqzmRsm5XVD6Dg7NTOlpqjfREr3IEwiej7MT_fhNOBnA3DMFs-rl-aVUPRQzoInQqcJDyKAR40D2VzepgED6UEUt4aB4fLAQ3_-_qydSeY-DAqg9lMYqwFxTpi0EdB1rKJZoKax3QQAaBmeBMuRA2JJmBoS4WAhizYbxZ-dP9NVNPUQ
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "postback_subscription": {
    "id": 105,
    "http_method": "post",
    "uri": "http://lueilwitzlittel.info"
  }
}

Generated by aglio on 08 Jun 2021