SOAP/REST API Best Practices Guide - DocuSign

More documents

Recommendations

Info

DocuSign Connect Service Guide2Table of ContentsDocuSign Connect Service .................................................................................................................. 3Introduction .................................................................................................................................... 3Setup ................................................................................................................................................... 4Setting Up the Connect Service in Your Account ........................................................................... 4XML Information Structure ................................................................................................................... 6Key Transaction Elements ............................................................................................................. 6Form Field Data ............................................................................................................................. 7Technical Details ................................................................................................................................. 8Running the Service....................................................................................................................... 8Best Practices ................................................................................................................................ 8Connect SOAP Publishing ............................................................................................................. 8Publish Failures ............................................................................................................................. 9Manually Publishing Transactions ............................................................................................ 9Sample API Calls and Schema: ............................................................................................... 9Sample Connect Service Message .............................................................................................. 11111 Sutter Street, Suite 1000, San Francisco, CA 94104 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.
DocuSign Connect Service Guide3DocuSign Connect ServiceThis guide provides a developer or business analyst with information about how the DocuSign ®Connect Service, sometimes referred to as the publisher in this document, works and discusses thedata elements that are available.IntroductionThe DocuSign Connect Service enables the sending of real-time data updates to externalapplications. These updates are generated by user transactions as the envelope progresses throughactions to completion. The Connect Service provides updated information about the status of thesetransactions and provides updates that include the actual content of document form fields; however,these updates might or might not include the document itself. The Connect Service is useful toorganizations that want a real-time view into the transactions across their user base in a centralizedlocation. This information can be customized to drive reporting or workflow specific to thatorganization’s needs.The DocuSign Connect Service acts on behalf of user accounts when transactions reach specifiedtriggers. At that point, an XML status change is sent to the customer’s system. The general flow ofevents is outlined below.Connect Service Basic FlowchartEvents/Actions DocuSign System Customer SystemEnvelopeEventRecipientActionEvents andActions arefinalized andworkflow isupdatedConnectService sendsupdated statusHTTP or XMLpost isreceived fromDocuSignAn organization’s external application can use a secure (HTTPS) ‘listener’ or a SOAP interface toaccept information from the Connect Service.• The ‘listener’ is an application that accepts XML transactions sent from the DocuSign ConnectService as events happen. This interface is not a SOAP API, such as the other interfaces inthe DocuSign System, instead the messages are sent through an HTTP POST.111 Sutter Street, Suite 1000, San Francisco, CA 94104 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.
Page 1 and 2: DocuSignInformation GuideAPI Best P
Page 3 and 4: API Best Practices Information Guid
Page 5: DocuSign Connect Service Guide1Copy
Page 9 and 10: DocuSign Connect Service Guide53. I
Page 11 and 12: DocuSign Connect Service Guide7Reci
Page 13 and 14: DocuSign Connect Service Guide93. H
Page 15 and 16: DocuSign Connect Service Guide11Thi
Page 17: 111 Sutter Street, Suite 1000, San

SOAP/REST API Best Practices Guide - DocuSign

Create successful ePaper yourself

Delete template?

Save as template?