I'm using the DocuSign eSignature API, and am generating client code with the help of the openapi codegen (via these https://github.com/docusign/OpenAPI-Specifications).
Now I have to use the DocuSign Manage API (https://developers.docusign.com/docs/admin-api/), too, but I can't find any Swagger / OpenAPI definition for that?
Is it somewhere hidden, does it not exists, and are there plans to make it available at one point? Are there any other options, SDKs, anything or do I have to make these calls "manually"?
Unfortunately, the Swagger file for the Admin API is not yet available.
That's also why DocuSign doesn't yet have SDKs for the API yet.
I don't have access to any scheduling information on it.
I suggest that you handle any Admin API calls you need to do manually for now.
What language are you creating SDKs for with CodeGen? (Please answer in a comment or by editing your original question.)
Related
Right now I'm exploring potential options for automating the process of creating and configuring new DocuSign developer accounts via API calls, as this would allow my team to greatly reduce the work needed to setup and configure these accounts manually. I can't find any information in the current DocuSign API documentation that would allow for this, and the only question I could find online was Is it possible to create a DocuSign developer account via REST calls? from 2019.
Is it possible to create new developer accounts via an API? The POST requests utilized by the UI don't look to be designed in a way that would easily allow for this.
There's an endpoint in the eSignature API called Accounts:Create that enables creating new accounts.
However, it's important to note this:
This method is restricted to partner integrations. You must work with DocuSign Professional Services or DocuSign Business Development, who will provide you with the Distributor Code and Distributor Password that you need to include in the request body.
Is the option to embed the Docusign UI is available under the Basic API plan as detailed in the below link?
https://developers.docusign.com/docs/esign-rest-api/how-to/embed-ui/
We don't need embedded signing but want to use the UI to prep and send the docs for e-signature.
Yes, it is. Basic API plan gives you many of the eSignature features and embedded UI is possible if you can make API calls.
I have a standard DocuSign account and I want to add an integration key but I am not able to add that key as there is no option to in my standard account to add the key. Further, I want to hit DocuSign API either through nodejs-sdk or postman to create and send an envelope with the use of the template. So, for this what should I do? Can anybody help, please?
Sounds like you're just getting started with the DocuSign eSignature API. Welcome! We have a variety of resources that you will find helpful.
I would start here on the DocuSign Developer Center.
To begin experimenting with our API, you'll first need to create a demo sandbox account. Within this account, you can provision your own integrator keys. Later down the road, you will follow our "Go-Live" process to transition your integration to our paid, production environment.
Once you have your account created, I would suggest you check out this quickstart code example.
That should get you started!
You should create a new developer/sandbox account to create an integration key. You cannot do that in production.
For node.JS we have a few different resources you can use, the most complete one is our code example "launcher" that can be used as a full app to try the code. We also have a quickstart that you an use without configuring the API authentication part.
I'm trying to use this route https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/get to get information on a specific Envelope in DocuSign, and I wanted to add the ?include=recipients parameter so as to get individual signers status too, but the parameter does not seem to do anything
Trying other values to include (documents, tags, etc). Doesn't change the response either.
Same result whether I try from my own code or from DS' "API explorer" tool
Am I using it wrong or is it a bug in the API?
This parameter (?include=recipients) is a new addition in the v2.1 API. You should ensure that the API endpoint you are calling has the v2.1 in the URL and not v2. You cannot use this feature with the v2.0 API. There are other reasons to use latest API 2.1 and it's supported by all SDKs.
I want to run a node script as a cronjob which uses Gmail's API to poll a gmail account I own.
I am following these quickstart instructions:
I'm stuck on the first step. When requesting credentials for a cron script it tells me that "User data cannot be accessed from a platform without a UI because it requires user interaction for sign-in":
The docs are confusing in general, and mention "service accounts," "OAuth," and other things -- I cannot tell which apply to my use-case and which don't. I've used many SaaS APIs, and the typical workflow is to login to your account, get an API key and secret, and use those in your script to access the API. It seems this is not the paradigm used by the Gmail API, so I'd appreciate any guidance or links to clearer instructions.
I also find that the documentation can be confusing at times, but what you want to to is actually pretty straight forward once you get it:
Register your App at Google, and say what APIs you want your App to have access to (only the Gmail API in this case). This will give you two strings, a client_id and a client_secret (which is the content of the client_secrets.json-file above).
Since you are just going to write a script for your own account only, you don't need a http-server. The Oauth Playground will suffice. Press the Settings Cog on the top right and use your own OAuth credentials.
Select the Gmail API in the list of APIs and follow the outlined steps.
Now you have an access_token and a refresh_token you can use to keep your script going indefinitely!
To fully understand the use of Gmail API, going through Gmail API Overview really will make a difference.
And you can also use these documentations to start building a Gmail app:
The client libraries are available for download in several languages and simplify making API requests.
The developer guide topics help you better understand how to implement particular use cases.
The API reference gives you details on every resource and method in the Gmail API.
I hope these help.