Проверка Docusign API: что такое отслеживание ответа?

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

Трассировка должна быть необработанным, полностью потребляемым запросом и ответом, включая заголовки. DocuSign должен иметь возможность воссоздать событие, используя предоставленную трассировку. Мы ищем глагол / метод, URI, конечную точку, метод аутентификации, учетные данные и полезную нагрузку. Намерение состоит в том, чтобы убедиться, что ваши группы поддержки могут предоставить эту информацию при обращении в службу поддержки DocuSign для поддержки серверной части.

- Источник Docusign


person Elijah Murray    schedule 26.11.2013    source источник


Ответы (2)


Они ищут вас, чтобы продемонстрировать свою способность производить полную трассировку как запроса, так и ответа для вызова API, выполняемого вашим приложением. Например, если мое приложение выполнило вызов «Создать конверт», то мой след запроса может выглядеть примерно так:

POST https://demo.docusign.net/restapi/v2/accounts/201105/envelopes HTTP/1.1

Host: demo.docusign.net
Connection: keep-alive
Content-Length: 568
Cache-Control: no-cache
Origin: chrome-extension://fdmmgilgnpjigdojojpjoooidkmcomcm
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
X-DocuSign-Authentication: {"Username":"USER_NAME","Password":"PASSWORD","IntegratorKey":"INTEGRATOR_KEY"}
Content-Type: application/json
Accept: */*
Accept-Encoding: gzip,deflate,sdch
Accept-Language: en-US,en;q=0.8,fr;q=0.6

{
  "emailSubject": "Please sign this",
  "emailBlurb": "Please sign...thanks!",
  "templateId": "3C9D42D3-3E76-4669-861E-9670415E1AD3",
  "templateRoles": [
   {
      "roleName": "Signer1",
      "name": "John Doe",
      "email": "[email protected]",
      "recipientId": "1",
      "clientUserId": "123",
    }
  ],
  "status": "sent"
}

И мой след (успешного) ответа будет выглядеть так:

HTTP/1.1 201 Created
Cache-Control: no-cache
Content-Length: 195
Content-Type: application/json; charset=utf-8
Date: Tue, 26 Nov 2013 19:06:05 GMT
Strict-Transport-Security: max-age=7776000; includeSubDomains

{
  "envelopeId": "aab13a9d-c4f7-4d95-b31c-11eed676cbc5",
  "uri": "/envelopes/aab13a9d-c4f7-4d95-b31c-11eed676cbc5",
  "statusDateTime": "2013-11-26T19:06:05.4064392Z",
  "status": "sent"
}

Обратите внимание, что трассировки включают в себя всю информацию - то есть трассировка запроса включает ГЛАГОЛ, URI, все заголовки и тело запроса; Трассировка ответа включает заголовки и тело ответа. Вы можете легко генерировать трассировку запросов / ответов, используя такой инструмент, как Fiddler или что-то подобное.

По сути, DocuSign хочет, чтобы вы продемонстрировали, что вы можете создать трассировку запросов и ответов для вызова API, потому что, если у вас когда-либо возникнут проблемы с API в будущем и вам потребуется обратиться в службу поддержки DocuSign за помощью, первое, что они собираются сделать просить вас - это полная трассировка запросов и ответов на проблемные вызовы API. Обеспечивая в рамках процесса сертификации API, что вы можете создавать трассировки запросов / ответов для своей интеграции, они гарантируют, что вы сможете предоставить службе поддержки DocuSign информацию, необходимую для устранения ваших проблем, если / когда это время когда-нибудь придет.

person Kim Brandl    schedule 26.11.2013

Чтобы получить журнал трассировки API, вам необходимо перейти на эту страницу -

https://support.docusign.com/guides/ndse-user-guide-api-request-logging

и перейти к

https://app2.docusign.com/preferences/security

и включите и щелкните журналы api, которые содержат несколько zip-файлов, содержащих файлы .txt.

person RN Kushwaha    schedule 18.02.2016