Разделы этой статьи:
Использование запросов на подпись
Рабочий и тестовый режимы
Прежде чем запустить приложение, вы можете протестировать запросы в тестовом режиме. Так вы сможете еще до запуска удостовериться, что рабочий процесс осуществляется так, как вы планировали, а также разобраться с непредусмотренными ошибками в работе приложения.
Чтобы показать запросы, сделанные в тестовом режиме, переведите переключатель из положения Рабочий режим в положение Тестовый режим. Вы можете переключиться обратно в рабочий режим, чтобы на панели API отобразились реальные события с вашего сайта.
Статистика
Вкладка Статистика дает общее представление о ваших данных API. Здесь вы можете быстро просмотреть графики с вашими запросами API, статусами запросов на подпись и использованием функции запросов на подпись. Вы можете настроить представление графика для этих данных по типу данных, диапазону дат и статусу ошибки (можно отфильтровать по распределению ошибок API, конечной точке или HTTP-статусу) с помощью раскрывающегося меню в верхней части страницы. Также можно проверить журналы событий для приложения и аккаунта.
На вкладке Статистика можно также узнать, сколько запросов на подпись еще доступно из существующего лимита, и посмотреть основные платежные данные.
Статус запросов на подпись
На вкладке Статус запросов на подпись вы найдете идентификаторы документов, статусы запросов на подпись, а также дату и время событий. Информацию на этой странице можно отфильтровать по дате и статусу запроса на подпись, воспользовавшись раскрывающимся меню в верхней части страницы.
Обратные вызовы приложения
Вкладка Обратные вызовы приложения позволяет настраивать и отслеживать действия с пользовательским интерфейсом (UI), там предоставляется подробная картина взаимодействия пользователей со встроенными функциями.
Обратные вызовы приложения запускаются, когда происходит заранее запрограммированное действие («событие»), связанное с определенным приложением. На этой вкладке будет отображаться только информация, связанная с встроенными запросами.
Подробнее об обратных вызовах и их настройке на панели API Dropbox…
Обратные вызовы аккаунта
Вкладка Обратный вызов аккаунта позволяет устанавливать и отслеживать события сервера для оптимизации рабочего процесса и минимизации времени задержки.
Обратные вызовы аккаунта уведомляют ваше приложение о событиях, связанных с вашим аккаунтом, отправляя данные события на URL-адрес обратного вызова аккаунта — другими словами, в момент генерации полной информации, содержащейся в событии. Их можно отфильтровать по дате и типу события, воспользовавшись раскрывающимися меню.
Задать URL обратного вызова аккаунта можно с помощью вызова API аккаунта или вручную на странице Настройки .
Подробнее об обратных вызовах и их настройке на панели API Dropbox…
Запросы API
Вкладка Запросы API предоставит обзор функциональности отправленных вами запросов на подпись, чтобы вы могли быстро найти и устранить любые ошибки в запросах.
Эти запросы API можно отфильтровать по дате, статусу HTTP, методу и конечной точке, воспользовавшись раскрывающимся меню в верхней части страницы.
Коды состояния HTTP отображают статус взаимодействия между вашим браузером и сервером. С помощью панели API можно фильтровать запросы по коду состояния HTTP, чтобы быстрее разобраться, какие запросы требуют внимания, а какие уже функционируют как планировалось.
Вот как расшифровываются коды состояния HTTP:
- Informational коды означают, что сервер еще не завершил обработку запроса (коды 100—199).
- Коды Success указывают на то, что запрос к серверу выполнен без ошибок (коды 200—299).
- Коды Redirectional показывают, что запрос был получен, но затем перенаправлен в другое место (коды 300—399).
- Коды Client error сообщают о том, что страница недоступна. Это ошибка на стороне сайта. Она обычно возникает, когда на сайте нет искомой страницы (коды 400—499).
- Коды Server error возникают, когда запрос был сделан корректно, но сервер не смог выполнить запрос должным образом (коды 500—599).
Запросы на подпись также можно отфильтровать по методу:
- Метод GET используется для получения или чтения ресурса.
- Метод POST используется для создания нового ресурса.
- Метод DELETE используется для удаления ресурса целиком.
- Метод PUT используется для изменения всего ресурса.
- Метод PATCH используется для изменения части ресурса.
Чтобы отфильтровать запросы по конечным точкам:
- Создайте любой другой параметр запроса, нужный вам для этого представления (например, это может быть дата, код состояния HTTP или метод).
- Нажмите Конечная точка.
- Выберите Определяемая пользователем.
- Поставьте галочку рядом с любой применимой конечной точкой.
- Нажмите Применить.
Список конечных точек доступен в обзоре запросов на подпись.
Использование запросов на подпись
Запросы на подпись можно использовать, чтобы проверить данные, относящиеся к запросу, включая имена и адреса электронной почты подписывающих лиц, настраиваемые поля, метаданные, данные ответов и метки времени создания и завершения запроса. Данные по использованию можно отфильтровать по дате и идентификатору клиента.
Обратите внимание: использование запроса на подпись также будет представлено в виде диаграммы на странице Статистика.
Приложения и ключи
Вкладка Приложения и ключи перенаправляет вас на страницу настроек, где можно просматривать подключенные приложения и ключи API, а также управлять ими.
Подробнее о том, как создать несколько ключей API и управлять ими…
Скачивание файла CSV
На вкладке Скачивание файла CSV отображается журнал запросов на подпись для вашего аккаунта в пределах заданного диапазона дат. Его можно экспортировать как файл с расширением .csv.
Вот как это сделать:
- Войдите в аккаунт Dropbox Sign.
- Выберите API.
- Нажмите Показать панель управления API.
- Нажмите Скачать файл CSV.
- Введите диапазон дат, для которого вы хотите экспортировать данные.
- Нажмите Скачать CSV.
Перейдите на панель управления Dropbox Sign API, чтобы начать работу.
Ресурсы по схожим темам
- Подробнее о доступных функциях и о панели API читайте в нашем руководстве по панели API.
- Подробнее о настройке и запуске Dropbox Sign API читайте в нашем кратком руководстве по API.
Если у вас появились вопросы или возникли проблемы, отправьте запрос здесь.
Комментарии
0 комментариев
Статья закрыта для комментариев.