Трудно представить более простой способ изучения API, чем Почтальон. Основанный как побочный проект для решения конкретной проблемы упрощения процесса тестирования API, Postman стал ведущей в мире платформой API с более чем 500 000 компаний (в том числе 98% из списка Fortune 500), и PandaDoc не является исключением.
Короче говоря, Postman — это платформа API для создания и использования API. Postman упрощает каждый шаг обнаружения API и оптимизирует сотрудничество между компаниями и конечными пользователями.
Команда PandaDoc и общедоступное рабочее пространство были представлены почтальоном, и мы рады, что у нас есть инструмент, помогающий публично делиться нашим API со всем миром.
В этом разделе описывается, как вы можете обнаружить PandaDoc API с помощью Postman в несколько кликов:
- Создать бесплатную учетную запись песочницы
- Коллекция импортного почтальона
- Установить значения для переменных
- Создайте и отправьте свой первый документ
Пойдем!
Создайте бесплатную учетную запись песочницы
Во-первых, вам нужно создать учетную запись в песочнице разработчика, чтобы бесплатно протестировать PandaDoc API.
Следующим шагом является подтверждение вашего адреса электронной почты.
Примечание. Для выполнения вызовов API требуется подтверждение адреса электронной почты.
Затем вам нужно сгенерировать ключ песочницы API.
Вот и все! У вас все готово 💪
Импорт коллекции почтальона
Импортируйте коллекцию PandaDoc прямо со страницы нашей документации: SDKs & Postman Collection
Выберите предпочтительную платформу использования.
И завершите процесс импорта.
С коллекцией вы получаете среду со всеми переменными, представленными в методах API.
Установить значения для переменных
Добавьте ключ песочницы API.
Добавьте идентификатор шаблона, чтобы протестировать наши мощные шаблоны.
Примечание. Обратите внимание, что простой шаблон API не предоставляет все функции, доступные через API. Набор содержит только переменные, поля, изображения и таблицу цен.
Примечание: в качестве получателя мы добавили фиктивный адрес электронной почты ([email protected]). Пожалуйста, измените его в среде, если это необходимо.
Создайте и отправьте свой первый документ
В этой статье мы покажем вам, как создать документ из шаблона. Кроме того, в PandaDoc есть возможность создания документа из загруженного PDF-файла. С точки зрения API процесс создания документа такой же, поэтому мы просто предоставляем образцы в формате PDF и ссылку на документацию.
Откройте `Созданный документ из шаблона PadnaDoc` и нажмите «Отправить». Успешный ответ означает запуск процесса создания документа (асинхронная операция).
Примечание. Убедитесь, что вы выбрали среду для вызовов API.
Проверьте статус документа и убедитесь, что документ находится в статусе `document.draft`. Документы с предварительно заполненными полями/переменными/получателем в статусе `document.draft` отображаются в PandaDoc.
Примечание. Идентификатор документа – это переменная, которая автоматически заполняется значением из предыдущего ответа.
Отправить документ. Не беспокойтесь, мы используем параметр "silent": true, поэтому электронные письма отправляться не будут.
Откройте представление получателя, используя ссылку общего доступа из предыдущего ответа, и подпишите документ.
Статус документа изменится на document.completed после того, как все получатели подпишут документ.
Конечно, это самый простой процесс создания документа без каких-либо настроек, но в сотрудничестве с Postman PandaDoc может показать ценность нашего API за считанные минуты.
Вот несколько полезных ссылок:
Спасибо!
