Блог

Главная - Вопросы по программированию - Формат веб-книг Docusign Connect JSON

Формат веб-книг Docusign Connect JSON

#docusignapi #webhooks #docusignconnect

Вопрос:

Я использую Docusign Connect webhooks на демо-счете (Node.js).

Я тестировал получение веб-ссылок, используя конфигурацию для каждого конверта, и хотел получать веб-ссылки в формате JSON вместо XML.

Когда я настраиваю как таковой на уровне учетной записи, веб-крючки поставляются с полезной нагрузкой JSON. Однако в конфигурации для каждого конверта они продолжают поступать в виде XML.

Разве полезная нагрузка JSON уже не поддерживается в этой конфигурации? Упомянуто здесь

Я использую стандартный объект EventNotification с данными о событиях в соответствии с примерами:

 eventData: {
            version: 'restv2.1',
            format: 'json',
            includeData: ['custom_fields', 'extensions', 'folders', 'recipients'],
        },

В чем здесь может быть проблема?

Ответ №1:

Наиболее распространенной возможной проблемой является ваш SIM-мод (SIM = Отправить отдельное сообщение). Как ясно указано в блоге Ларри, формат JSON можно использовать только в том случае, если вы используете агрегированный режим, он не поддерживается для отдельных сообщений.

Чтобы изменить режим SIM-карты, перейдите на страницу подключения в настройках администратора eSign и выберите нужный режим.

Ответ №2:

Доступен формат JSON для обратной записи подключения. При работе с eventNotifications часть, которая определяет, будет ли она выполнять обратную запись в формате JSON или XML, — это включение параметра EventData, который вы разместили здесь. Если вы избавитесь от части EventData, обратная запись возобновится в XML вместо JSON.

Пример обратной записи XML:

 "eventNotification": {
        "url": "https://asdfasdf.proxy.webhookapp.com",
        "requireAcknowledgment": "true",
        "loggingEnabled": "true",
    "includeDocuments":"true",
        "envelopeEvents": [
            {"envelopeEventStatusCode": "Sent"},
            {"envelopeEventStatusCode": "Delivered"},
            {"envelopeEventStatusCode": "Completed"},
            {"envelopeEventStatusCode": "Declined"},
            {"envelopeEventStatusCode": "Voided"}
        ],
        "recipientEvents": [
            {"recipientEventStatusCode": "Sent"},
            {"recipientEventStatusCode": "Delivered"},
            {"recipientEventStatusCode": "Completed"},
            {"recipientEventStatusCode": "Declined"},
            {"recipientEventStatusCode": "AuthenticationFailed"},
            {"recipientEventStatusCode": "AutoResponded"}
        ]
    }

Пример обратной записи в формате JSON:

 "eventNotification": {
        "url": "https://asdfasdf.proxy.webhookapp.com",
        "requireAcknowledgment": "true",
        "loggingEnabled": "true",
        "envelopeEvents": [
            {"envelopeEventStatusCode": "Sent"},
            {"envelopeEventStatusCode": "Delivered"},
            {"envelopeEventStatusCode": "Completed"},
            {"envelopeEventStatusCode": "Declined"},
            {"envelopeEventStatusCode": "Voided"}
        ],
        "recipientEvents": [
            {"recipientEventStatusCode": "Sent"},
            {"recipientEventStatusCode": "Delivered"},
            {"recipientEventStatusCode": "Completed"},
            {"recipientEventStatusCode": "Declined"},
            {"recipientEventStatusCode": "AuthenticationFailed"},
            {"recipientEventStatusCode": "AutoResponded"}
        ],
        "eventData": {
            "version": "restv2.1",
            "format":  "json",
            "includeData": ["custom_fields", "extensions", "folders",
                "recipients", "powerform", "tabs", "payment_tabs","documents"]
        }

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

С уважением, Мэтт

Метки: