Исследуйте и тестируйте Dataverse на тестовой площадке веб-API (предварительная версия)
[Данный раздел посвящен предварительному выпуску и может быть изменен.]
Тестовая площадка API — это инструмент тестирования программного обеспечения с предварительной аутентификацией, который помогает разработчикам быстро и удобно взаимодействовать с веб-API Microsoft Dataverse.
Это веб-приложение позволяет разработчикам тестировать различные конечные точки API и экспериментировать с ними без необходимости в сложной настройке или процессах аутентификации. На ней также удобно представлены определенные доступные действия и ссылки на документацию для более быстрого обучения.
Используйте этот инструмент, чтобы изучить возможности API RESTful, протестировать определяемые пользователем рабочие процессы и многое другое.
Важно!
- Это предварительная версия функции.
- Предварительные версии функций не предназначены для использования в производственной среде, а их функциональность может быть ограничена. Они доступны перед официальным выпуском, чтобы клиенты могли досрочно получить доступ и предоставить отзывы.
Ключевые функции
- Предварительная аутентификация: тестовая площадка API поставляется в предварительно аутентифицированном виде, поэтому разработчики могут сразу же приступить к тестированию конечных точек API и экспериментированию с ними.
- Веб-интерфейс: благодаря тестовой площадке API разработчики могут быстро взаимодействовать с веб-API Dataverse без необходимости в сложной настройке, такой как загрузка программного обеспечения или настройка учетной записи стороннего производителя (не Microsoft). Вы можете получить доступ к этому инструменту из ускорителя Dataverse — приложения Microsoft, доступного во всех новых средах Dataverse, которое можно установить в любой среде.
- Удобство: предоставляет различные действия и возможности, доступные в веб-API Dataverse, что позволяет легко и быстро узнать, что возможно и как это реализовать.
Предварительные условия
У вас должен быть доступ к Dataverse и доступ к запуску приложения-ускорителя Dataverse. Участники роли безопасности «Настройщик системы» имеют доступ к запуску приложения.
Начать
Чтобы начать работу с тестовой площадкой API, запустите ускоритель Dataverse, а затем выберите страницу Тестовая площадка API.
Отправляйте запросы к веб-API Dataverse
На главном экране выберите тип запроса, чтобы открыть редактор запросов, выбрав Создать на любой из верхних карточек.
Представлено три типа запросов:
| Тип | Описание |
|---|---|
| Пользовательский API | Сюда входят любые действия, функции от Microsoft или любые общедоступные определяемые пользователем пользовательские API для веб-API Dataverse, зарегистрированные в рабочей среде. |
| Моментальный подключаемый модуль | Мгновенные подключаемые модули классифицируются как любые пользовательские рабочие процессы, зарегистрированные как пользовательский API в среде со связанным выражением FxExpression. |
| Запрос OData | Обеспечивает более детальный контроль над входными данными запроса для отправки запросов OData. |
Запрос пользовательского API или мгновенный подключаемый модуль
Эти типы запросов предназначены для упрощения вызова подключаемых модулей, доступных в рабочей среде.
Выберите вариант из основного раскрывающегося списка, в котором представлены доступные подключаемые модули в текущей среде.
Если параметры доступны, они отображаются в появившейся таблице Параметры запроса. Укажите значения для обязательных параметров.
Примечание
Флажки слева от каждого параметра указывают, включены ли они в запрос. У обязательных параметров сняты флажки, а у необязательных параметров есть редактируемые флажки.
Выберите Отправить.
Обратите внимание на ответ в нижней части экрана.
Примечание
Интерфейс предоставляет удобный список всех доступных подключаемых модулей в среде. Если этот флажок установлен, отображаются связанные параметры с типами данных. В фоновом режиме вызов OData по-прежнему выполняется, но интерфейс упрощает построение вызова.
Выполнение запроса OData
Запросы OData предоставляют больше возможностей для параметров запросов.
Выберите Метод HTTP-запроса в первом раскрывающемся списке.
Введите URL-адрес конечной точки. Включайте URL-адрес запроса только после
[OrgUrl]/api/data/v9.2/Добавьте параметры запроса, используя один из двух методов:
В URL-адресе.
После знака вопроса (
?) в URL-адресе введите ключ параметра запроса.
Введите знак равно (
=) после ключа.Введите значение.
Ключи и значения автоматически заполнят таблицу параметров в интерфейсе.
Добавьте параметры запроса вручную, выбрав + Добавить параметр. При этом в таблицу добавляется пустая строка параметра, в которую можно вводить значения. URL-адрес обновляется динамически по мере ввода значений.
При необходимости укажите текст (если используются все методы запроса, кроме GET), выбрав вкладку Текст, а затем введите значение текста в элементе управления редактора.
Выберите Отправить.
Обратите внимание на ответ в нижней части.
Просмотрите ответ
После отправки запроса ответ отображается в нижней половине экрана.
Статус ответа предоставляет быстрые метрики по запросу:
- Сообщение о состоянии
- Длительность (в миллисекундах)
- Размер (в килобайтах)
Текст ответа отображается под статусом ответа. Щелкните значок копирования, чтобы скопировать текст ответа в буфер обмена.
Вопросы и ответы по
Какие привилегии необходимы для доступа к средству работы с тестовой площадкой API?
У вас должен быть доступ к приложению-ускорителю Dataverse для использования этого инструмента.
Инструмент тестовой площадки API подключается только к веб-API Dataverse?
Да, инструмент тестовой площадки API подключается только к веб-API Dataverse. Никакие другие службы недоступны для подключения в этом интерфейсе.
Как инструмент тестовой площадки API аутентифицируется с веб-API Dataverse?
Инструмент использует токен аутентификации вошедшего в систему пользователя, который необходим для запуска приложения-ускорителя Dataverse.
Во всех ли средах доступна функция тестовой площадки API?
Эта функция предоставляется через ускоритель Dataverse и доступна во всех средах, где установлено это приложение. Приложение автоматически устанавливается во всех новых средах, но его также можно установить и в более старых средах, следуя инструкциям по установке.