Getting and Using Your Integrator Key

Along with the new rate limits, DocuSign will now enforce the use of an integrator key when using the API! This blog entry is designed to help you understand the logic behind the key, as well as how to use it with your new and existing integrations.
What is this integrator key?
The integrator key identifies a single integration. It enables you to send requests using the API along with a username/password combination.
How many integrator keys should I have?
You should have as many integrator keys as you have distinct integrations with DocuSign. Updates to a single integration do not need different integrator keys.
How do I get an integrator key?
Follow these simple steps to activate an integrator key in demo:

1. Log into your demo console with the credentials you use to access the API
2. Click on Preferences
3. Scroll down and click on API
4. Follow the instructions on the page to activate a new integrator key

Now that I have a key, how do I use it?
If you authenticate in the  SOAP header, then you must combine the integrator key with the username like this:

[Integrator key]username

If you authenticate in the HTTP header, then you will add it to the header, under the name “X-DocuSign-Authentication” along with your other credentials.

For more information and example headers, take a look at the DocuSign API documentation.
I already have integration in production. How do I use my integrator key there?
In order to use an integrator key in the production environment, you must first have one in the demo environment. After you test the key with your integration in demo, you can request its migration to production by following these steps:

1. Log into your demo console with the credentials you use to access the API
2. Click on Preferences
3. Scroll down and click on API
4. Next to the integrator key you wish to use in production, click the “Request Migration to Production” link
5. Fill out the PowerForm

You will be notified once your request has been approved.

Please note: DocuSign will decline your key request if you have not successfully completed certification! You can always submit the form again once you complete certification.

Questions about integrator keys and how to use them? Post them on our community forums!

Want to learn more about the solutions in the DocuSign ecosystem? Click to take a look at the DocuSign Marketplace! Interested in a free developer account? Register today to download our free SDK!