Посмотрите конверт по DocumentId?

Question

Я только начинаю с API-интерфейса DocuSign REST (создавая интеграцию с доказательством концепции с продуктом моей компании) и пытаюсь оборачивать вокруг себя все. Есть пару вещей, которые я не могу найти много информации о:

1. При создании конверта, делает documentId дела? Я предполагаю, что если есть несколько документов, documentId для каждого из них должны быть разными. Используется ли он где-нибудь еще?

2. Периодически я бы хотел проверить события аудита для конверта. Было бы намного проще, если бы я смог найти конверт (или перейти прямо к событиям аудита, не просматривая конверт) вместо documentId. Это возможно?

Наш продукт уже хранит документы, и, следовательно, имеет documentId - так что это ID я использую при создании конвертов. То, что я хотел бы сделать, - с любым документом, который я просматриваю в нашем продукте, - проверить, ожидаются ли незавершенные конверты. Тогда мне не нужно было бы хранить какие-либо данные, связанные с DocuSign, в нашей системе (то есть envelopeId).

Могу ли я найти конверт на documentId, который использовался для его создания?

Answer 1

1. The documentId является клиентом определенного имущества и просто там, чтобы помочь вам помечать документы, которые были использованы для данных конвертов. Если вы хотите отследить документы, которые вы поставляете в своих конвертах (что похоже на вас), вы можете использовать его для уникальной идентификации основных документов, и если у вас уже есть система, которая сгенерировала документы, то это должно сделать все проще.

2. Нет способа получить информацию о конверте через documentId. Лучшее решение, скорее всего, будет хранить простую таблицу на вашей стороне, которая связывает documentIds с номером envelopeIds, а затем дана documentId, которую вы хотите найти для использования связанного конверта, чтобы получить его статус.

Следует учитывать, что для некоторых вызовов API существуют определенные ограничения API-вызовов, и одним из них является запрос статуса конверта. Вам не разрешается запрашивать статус на определенном конверте более 1 раз каждые 15 минут. Вместо этого рекомендуется использовать модуль DocuSign Connect, если вы хотите отслеживать статус в реальном времени (DocuSign Connect передает статус вам, как только это случается, вместо того, чтобы вы часто проверяли статус).

Для получения дополнительной информации об ограничениях вызовов API проверить API Best Practices документ в Центре разработчиков DocuSign в разделе Go Live: https://www.docusign.com/developer-center/go-live/certification