Передача данных по сделкам и основным сущностям¶
Возможности:
- создание/редактирование/просмотр физических лиц;
- создание/редактирование/просмотр сделок и перенос их в другое ЮЛ;
- создание/редактирование/просмотр покупателей;
- создание/редактирование/просмотр строительных площадок;
- создание/редактирование/просмотр объектов недвижимости;
- создание/редактирование/просмотр договоров ДДУ/ДУПТ;
- загрузить документы;
- отслеживание изменений по сделкам.
Кейс 1: Как создать сделку в Сделка.РФ
Шаги:
- Создайте физлицо person, выполнив запрос
POST /person
с обязательными полями. -
Сделайте физлицо покупателем, выполнив
POST /buyer
и передав идентификатор физлица в этот запрос. -
Создайте саму сделку, выполнив
POST /deal
и передав туда идентификатор покупателя (buyerIds) который вы получили на 2 шаге.
Покупатель это роль в конкретной сделке. Это значит, что если физ.лицо участвует в нескольких сделках, то для каждой из них нужно создать отдельного покупателя.
У любого метода обязательные поля можно посмотреть в Schema ( в swagger). Обязательные поля помечаются “*“.
❗️Важно: поле может быть обязательно, но его значение может быть nullable: true. Это значит, что поле обязательно отправить, но его значение может быть null.
Кейс 2: Как загрузить файл документа
Для загрузки файлов используйте метод POST /upload
.
Особенности метода:
- это не
multipart/form-data
, можно загрузить только один файл за один запрос; - параметры файла передаются через заголовки, т.к. тело уже занято;
- заголовок
Content-Disposition
содержит не просто имя, а имеет специальный формат. Например,filename=journey.png
. - в API на данный момент нет возможности удалить файл, чтобы отвязать файл от какой-то сущности, передайте null в соответствующее поле;
- есть ограничения по размеру и типу файла.
Возможные форматы:
- application/pdf
- application/octet-stream
- application/rtf
- image/jpeg
- image/jpg
- image/png
- text/plain