ADN Open CIS
Сообщество программистов Autodesk в СНГ

Возможности API. Сервис для просмотра Viewing Service (Продолжение)

Первая часть

API для работы с элементами (Items API)

HEAD Items

При запросе заголовка API возвращает тот же самый набор, что и при вызове GET запроса. Заголовок может быть полезен для получения размера содержимого (Content-Length) перед получением потока данных.

HEAD /viewingservice/v1/items/{urn}

Пример запроса

Пример успешного ответа:

Параметры:

• urn – обязательный. URN запрашиваемого элемента. Валидным является только URN сервиса для просмотра в виде urn:adsk.viewing:fs.file:url-safe-base64-encoded-seed-urn/rest/of/the/path

Заголовки запроса:

• Range – необязательный. Согласно стандарту RFC 2616 заголовок Range задает ограничение возвращаемых данных. Например, Range:0-63 возвратит только первые 64 байта. Если Range не задан, то содержимое будет возвращено целиком.

Статусы:

• 200 – OK. Объект найден. Информация по нему возвращена.
• 400 – не верный запрос. Например, формат URN неправильный или параметр Range задан неверно
• 404 – не найден. По заданному URN объект не найден
• 500 – Внутренняя ошибка сервера. На сервере произошла непредвиденная ошибка.

GET Items

Данное API предоставляет доступ к элементам после того, как вы получили нужный URN с помощью GET запроса API для работы с моделью для просмотра. Это API напрямую возвращает потоковые данные для просмотра. Клиент должен воспользоваться данными сразу после их получения и разорвать соединение сразу же после завершения испльзования.

GET /viewingservice/v1/items/{urn}

Пример запроса:

Пример возвращаемого результата:

Статусы:

• 200 – OK. Объект найден. Информация по нему возвращена.
• 400 – не верный запрос. Например, формат URN неправильный или параметр Range задан неверно
• 404 – не найден. По заданному URN объект не найден
• 500 – Внутренняя ошибка сервера. На сервере произошла непредвиденная ошибка.

API для работы с миниатюрами (Thumbnails API)

Получение миниатюр

Thumbnails API позволяет получить миниатюрные изображения в PNG формате.

GET /viewingservice/v1/thumbnails/{urn}?guid=$GUID$ & width=$WIDTH$ & height=$HEIGHT$ (& type=$TYPE$)

Примеры запросов:

Пример возвращаемого результата:

Параметры:

• urn – обязательный. URN запрашиваемого элемента. Валидным является только URN сервиса для просмотра в виде urn:adsk.viewing:fs.file:url-safe-base64-encoded-seed-urn/rest/of/the/path
• guid – не обязательный. Идентификатор подмножества видимых объектов.
• widht – не обязательный. Ширина миниатюры
• height – не обязательный. Высота миниатюры.
• type – не обязательный. Тип запрашиваемой миниатюры. Может быть одним из следующих значений: small, medium, large. Параметры высоты и ширины будут при этом игнорироваться.

Заголовки запроса:

• Range – необязательный. Согласно стандарту RFC 2616 заголовок Range задает ограничение возвращаемых данных. Например, Range:0-63 возвратит только первые 64 байта. Если Range не задан, то содержимое будет возвращено целиком.

Статусы:

• 200 – OK. Объект найден. Миниатюра возвращена
• 202 – Принято. Генерация миниатюры в процессе.
• 204 – Нет содержимого. Миниатюра по каким-то причинам не было сгенерирована.
• 400 – не верный запрос. Например, формат URN неправильный.
• 404 – объект для просмотра не был создан
• 500 – Внутренняя ошибка сервера. На сервере произошла непредвиденная ошибка.

API для работы со средством просмотра (Viewers API)

GET Viewer

Данное API возвращает основные компоненты для просмотра модели. Стоит отметить, что для вызова методов этого API не требуется аутентификация.

GET /viewingservice/v1/viewers/{file}?v={file_version}

Примеры запросов:

Параметры:

• file– обязательный. Компонент средства для просмотра, который необходимо получить. Может принимать следующие значения:
  • index.html – является готовой страничкой со средством просмотра. Может непосредственно встраиваться в вашу страницу.
  • style.css – каскадная таблица стилей. Может быть использована в случае, если клиент желает использовать стили средства для просмотра на своей пользовательской странице.
  • Viewer3D.min.js – является ядром средства для просмотра моделей. Используется в случае, если пользователь хочет кастомизировать функциональность средства для просмотра.
  • v – не обязательный. Версия компонентов средства для просмотра. Поддерживаются маски, например, v1.0.1, v1.0.*, v1.*.*
    Если не задан, то будет использована последняя версия. Если задана, конкретная версия, то будет использована она. Если задана маска, то будет использована последняя версия, удовлетворяющая маске.

Статусы:

• 303 – Смотреть другое. Указанный файл необходимо искать на другом сервере.
• 400 – не верный запрос. Например, неверно задан параметр
• 404 – указанный файл или версия не найдена.
• 500 – Внутренняя ошибка сервера. На сервере произошла непредвиденная ошибка.

Supported API

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

• Поддерживаемые расширения файлов
• Расширения для направления наложений
• Информация о регулярных выражениях

GET /viewingservice/v1/supported

Пример запроса:

Пример ответа:

Заголовки запроса:

• If-Modified-Since – не обязательный. Будет возвращен только тот список поддерживаемых форматов, которые были добавлены после указанной даты.

Заголовки ответа:

• Last-Modified – дата последнего измения

Статусы:

• 200 – ОК. Успешный результат.
• 304 – Нет изменений. Запрашиваемые данные не менялись с момента даты, указанной в заголовке Last-Modified.
• 500 – Внутренняя ошибка сервера. На сервере произошла непредвиденная ошибка.

Общие коды ошибок REST

Источник: https://developer.autodesk.com/api/view-and-data-api/#items-api