I am working on an application which is using the DocuSign API. I want to use the DocuSign website to create a template (I've done this), and then I want to use that template, along with template matching (does this work?), to match the signature fields with similar documents being uploaded. This process works if I do it exclusively with the DocuSign website. Using C# and the API, when I create an envelope and upload a document, it doesn't appear that the template matching is working : i.e. none of the signature fields are "sign-able".
What I don't want to do is select a template for the envelope (I can do that, and make it work). I want to use automatic template matching.
I'm looking for examples, pointers to documentation, or advice on how to accomplish this. I'm even willing to look at examples in other languages, and adapt those methods to C#.
Simple Answer:
Template Matching works ONLY in the User Web App
The API and Applications using the API are expected to specify exactly the template to use
There is one exception to this, both the Web App and the API honor User Shared Custom Tags, which are field/tab level templates effectively. Also remember you can create a template on the fly or use "inline" templates as part of the composite template envelope creation.
WEB App - https://10226ec94e53f4ca538f-0035e62ac0d194a46695a3b225d72cc8.ssl.cf2.rackcdn.com/quick-start-creating-custom-tags.pdf
API - https://docs.docusign.com/esign/restapi/CustomTabs/CustomTabs/create/
Related
I have 2 queries based on the following :
I recently followed this DocuSign article to pass a supplied document to Docusign via the API:
https://www.docusign.com.au/blog/get-the-flow-sending-docusign-envelopes-microsoft-power-automate?_ga=2.99447774.1174083755.1646148960-1179341585.1645460870
Query 1 - This all works apart from the AutoPlace text just isn't getting picked up. I added the variables as described in the article and referenced them in the document footer. The document is passed through the API call and the invitation to sign goes out ok. Is there anything I'm missing here? I can open the document for signing but docusign doesn't go to the places where the AutoPlace tags are, just leaves it open for the user to decide what to do. I've previously tried using AutoPlace using templates, but this is a document that will be sent through the API as it is provided by our users (with the correct AutoPlace intact). The article hints this should just work.
Update : this is now working but need advice on text color
signing screenshot
Update : Showing white signature on black background
white signature
Query 2 - Once the user has signed the document using the above, I want to trigger a power automate flow off. There is a trigger for this but when I try to form the connection to DocuSign, there is only a login for the main account, not the developer account. So the account where I've made the account from isn't the one where I can fire off the triggers from. This makes it impossible to then fire a flow when it has been sent to the API and subsequently signed. Is there a way to use the trigger using the same account as the API account? If not it seems a bit crazy that I can start the process using the API but then can't fire flows from the result of the signings.
We have a company account ( I'm working on behalf of Transport for Wales) but was told there is no API support at all, which also sounds a bit bizarre. Hoping someone can help me!
Query 1 - there's an AutoPlace settings that determine the scope - document/envelope for AutoPlace. You may want to see if the issue happens also when you use the web app and not from API - if the same challenge - then you need to contact support to change this scope. If not, it may mean you're not setting your templateRole correctly. It must match the same one that was defined on the template (case sensitive).
Query 2 - no, the OTB connector is production only. For the developer account you will need to use a custom connector for any REST API, not the one provided for you.
Does the Docusign REST API support pulling back all custom tags available for an account? The custom tags I'm referring to are found in Preferences -> Member Options -> Custom Tags. We're wanting to build a drag-n-drop interface for inserting available custom tags in our sales documents. I did review the documentation (https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm), but didn't find what I needed.
That capability isn't yet exposed in our APIs but is something we are considering for a future release.
This is now available via a call to GET /v2/accounts/{accountId}/tab_definitions
See https://docs.docusign.com/esign/restapi/CustomTabs/CustomTabs/list/
It appears from the REST API documentation that the TemplateID is a modifiable field through the "Modify a Template" call. When we test this we can change other fields using this call however the TemplateID does not change from our tests.
We are currently managing over 150 server templates and want to sync the TemplateIDs across our Demo and Production accounts to streamline the template migration process between our two accounts. Please advise on if/how it's possible to modify the templateID through the API.
Thank you.
The TemplateID is unique to the template upon randomly being generated by the system.
There is no way to assign or re-assign a TemplateId.
They will not match between different environments
We are using the following steps to successfully create our app while in testing mode but we cannot go live because the template ID is not there for a standard account.
We create the template at demo.docusign.net
We get the template ID
Our app works perfectly using API
But a normal user (our client) will create a template using docusign.com ... which does not Display the template ID and therefore he cannot put it in the APP.
How can I resolve this?
You have a couple options. When editing a template, the first page (which shows all of the details of the template) displays the Template ID at the top left. They could copy and paste it.
Arguably the better user experience is to use the DocuSign API to get a list of the available template names/IDs and let your users select the appropriate template within your app.
If you are using this https://github.com/docusign/docusign-csharp-client sample and testing please make sure you create a sandbox environment on docusign as the above sample uses https://demo.docusign.net/restapi as the Api URL,create integrator key and create template in demo environment only.I experienced same error(invalid template id) when I created a template on real(not sandbox) environment and used the above sample having demo API URL in my application and later when I changed to demo template id( by clicking cursor on (i)) I got the desired result.
Thanks
Ravi
I am writing an application that uses Docusign and I’m trying to figure out the best way to manage my Docusign account in general.
Here is the use case:
1) My software uses custom Docusign templates and tabs and uses the Docusign API to accomplish populating the templates, tabs, and generating envelopes
2) The user will have to provide their own Docusign account to use my software
Questions:
1) How do I get the custom templates loaded into their Docusign account?
Can templates be shared between totally disparate Docusign accounts?
Other options I think might work are an export or import of the templates (but that is clunky).
Maybe I can use the API to upload the templates as well???
2) Who’s Docusign Integrator Key do I use?
Do they need to generate one from their Docusign account and I use that one from my software? Or do I ALWAYS use my developer integrator key???
3) Who’s API username and password do I use to log in via the API?
I assume theirs, but I’m not a fan of needing to save a bunch of Docusign passwords in my database.
Any other options for setting this up the right way???
Thanks everyone!
For future inquires, include if you're using REST or SOAP.
Here are the answers to the questions that you have above.
1) How do I get the custom templates loaded into their Docusign account?
Can templates be shared between totally disparate Docusign accounts?
Other options I think might work are an export or import of the templates (but that is clunky).
Maybe I can use the API to upload the templates as well???
Templates can only be shared within users on the same account. There isn't a way to upload a template via the API either. You can use composite templates for a standardized template across multiple accounts (depending on SOAP/REST, the coding changes here)
2) Who’s Docusign Integrator Key do I use?
Do they need to generate one from their Docusign account and I use that one from my software? Or do I ALWAYS use my developer integrator key???
Your application will always use your Integrator Key, which will only work in Demo until you go through the Certification to get the Integrator Key promoted to production.
More info on that process here: https://www.docusign.com/developer-center/go-live/certification
3) Who’s API username and password do I use to log in via the API?
I assume theirs, but I’m not a fan of needing to save a bunch of Docusign passwords in my database.
Any other options for setting this up the right way???
You will need specific permissions enabled on a user and on an account to make API calls successfully. Most integration's use a system user to login and make these calls. If you're working within multiple accounts that you do not have administration over, you will end up running into permission errors.
It sounds like you're wanting to setup a Partner integration, which does differ a little from a standard integration.