Skip to main content

Открытие документа на редактирование

Осуществляется путем запроса Subscribeдокументного вебсокета, по которому поступает DOM модель документа с СО-сервера, передавая внутренний X-co-auth-token (cм. Рисунок).

Вид запроса Subscribe:

GET wss://coapi-server/<...>/api/v1/documents/<docId>/subscribe

Параметры запроса приведены в таблице.

Параметр запросаТип параметраОписание
docIdpathИдентификатор документа, обязательный параметр
timezoneOffsetMinsqueryЧасовой пояс, используемый для конвертации

В случае успешного соединения возвращается код ответа 101. Все остальные коды соответствуют ошибке.

Пример:​

curl -X GET 'wss://coapi-dora.devoffice.ru/api/v1/documents/5296_oczmv7vblpby/subscribe?X-co-auth-token=LaSUiqsbTVH5ySaBY6BlkCVdTc9jqabJ' \`<br/>`-H 'Pragma: no-cache' \`<br/>`-H 'Origin: https://docs-dora.devoffice.ru' \`<br/>`-H 'Accept-Language: en-RU,en;q=0.9,ru-RU;q=0.8,ru;q=0.7,en-US;q=0.6' \`<br/>`-H 'Sec-WebSocket-Key: 0XlDA9voMk+oYKZ8oT/GRQ==' \`<br/>`-H 'User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36' \`<br/>`-H 'Upgrade: websocket' \`<br/>`-H 'Cache-Control: no-cache' \`<br/>`-H 'Connection: Upgrade' \`<br/>`-H 'Sec-WebSocket-Version: 13' \`<br/>`-H 'Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits' \`<br/>`--compressed`