Обновление, удаление и выполнение с использованием интерфейса API
 |
В примерах в этом разделе предполагается, что вы знакомы с выполнением запросов HTTP POST в среде веб-разработки или в веб-приложении.
|
Следующие правила помогут понять, что необходимо делать в зависимости от типа выполняемого запроса.
|
Заметки
|
Образец URL-адреса
|
Действие HTTP
|
Тип содержимого
|
|||
|---|---|---|---|---|---|---|
|
ОБНОВЛЕНИЕ
|
Для обновления необходимо также указать фрагмент сущности
|
http://host/Thingworx/Things/thing_name
|
PUT
|
application/json или text/xml
|
||
|
УДАЛЕНИЕ
|
Для удаления необходимо также указать фрагмент сущности
|
http://host/Thingworx/Things/thing_name
|
УДАЛЕНИЕ
|
Н/Д
|
||
|
ВЫЗОВ СЕРВИСОВ
|
Для вызова сервисов необходимо указывать полный URL-адрес, включающий конкретную характеристику
|
http://host/Thingworx/Things/MyThing/Services/myService
|
POST
|
application/json
|
Выполнение HTTP-запросов
При выполнении HTTP-запросов используйте кодировку символов UTF-8 и при необходимости указывайте необязательное значение порта.
 |
В производственной среде рекомендуется использовать HTTPS, иначе целостность сети в любое время может оказаться под вопросом.
|
Обработка кодов HTTP-ответов
В большинстве случаев ожидается возвращение либо содержимого, либо кода статуса 200, что означает нормальное завершение. В случае обнаружения ошибки вы получите сообщение об ошибке.
Работа с HTTP-содержимым
При отправке или получении любого HTTP-содержимого (JSON, XML, HTML (только для ответов)), задавайте для заголовка Content-Type (типа содержимого) запроса значение, соответствующее отправляемому HTTP-содержимому.
|
Методы
|
|
|---|---|
|
GET
|
Загрузить значение.
|
|
PUT
|
Записать значение или создать новые вещи или свойства.
|
|
POST
|
Выполнить сервис.
|
|
УДАЛЕНИЕ
|
Удалить вещь или свойство.
|
|
Значения заголовка Accept
|
|
|---|---|
|
JSON
|
application/json
|
|
XML
|
text/xml
|
|
HTML
|
text/html (или опустить заголовок Accept)
|
|
CSV
|
text/csv
|
|
Значения заголовка Content-Type (типа содержимого)
|
|
|---|---|
|
JSON
|
application/json
|
|
XML
|
text/xml
|
Метаданные
Метаданные любой конкретной вещи, шаблона вещи или структуры, включаемых в компоновку, можно отобразить, если перейти в веб-браузере по следующему URL-адресу: NameoftheThing/Metadata
|
|
Чтобы эта информация была видимой, она должна отображаться в формате JSON.
|
Передача данных аутентификации с помощью вызова API REST
Рекомендуется использовать ключ приложения. Создайте ключ приложения в ThingWorx, а затем можно передать его с помощью вызова REST в виде HTTP-заголовка.
Замените Значение заголовка на ключ приложения, действительный для экземпляра ThingWorx, с которым планируется соединиться.
|
Ключ заголовка
|
Пример значения заголовка
|
|---|---|
|
appKey
|
1x9256cf-9fe9-434e-adbe-9772c0c40261
|
Интерфейс API ThingWorx REST поддерживает два других метода аутентификации:
• Базовая аутентификация позволяет выполнить аутентификацию с именем пользователя и паролем.
• Передача ключа приложения в качестве параметра URL. Этот метод не рекомендуется из-за соображений безопасности и будет исключен в будущем.
См. также