How to use the BoldSign Production API Key?

The BoldSign Production API key is a secure authentication mechanism used to identify and authorize users or applications making API requests in a live environment. It enables real-world document transactions and should be handled with care. You can generate up to two production API keys at a time, and an active subscription plan with API access is required to create them.

In contrast, the Sandbox API key is used for testing and development purposes only. It allows you to simulate signature workflows without triggering actual document deliveries or consuming production credits. This is ideal for building and validating your integration before going live.

Use the Sandbox key to test. Switch to the Production key only when your integration is ready for real usage.

Generate API Key

• Expand the API menu and select the API Key option.
• You will be directed to the API Key generation page. Click the Generate API Key button.

• A dialog box will appear. Choose the Live environment option by enabling the toggle button. By default, the Sandbox option is enabled.
• Then enter the name of your API Key in the Name section.
• You can give an expiration date for your API token by enabling the Token Validity toggle and selecting a validity date.
• Once done, click the Generate Token button.

• Your API key will be created and displayed. Make sure to copy and store it securely.

Use API key

To make an HTTP request with API Key, the request header must include the X-API-KEY.

• Copy the generated API key from your application.

• Then, paste it in your request code as demonstrated below.

Curl

curl -X GET 'https://api.boldsign.com/v1/document/list' -H 'X-API-KEY: {your API key}'

.Net

var apiClient = new ApiClient("YOUR_API_KEY");

var templateClient = new TemplateClient(apiClient);

var templateList = templateClient.ListTemplates(1);

Python

import boldsign

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:

    template_api = boldsign.TemplateApi(api_client)
    template_list = template_api.list_templates(page=1)

PHP

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\TemplateApi;

$config = new Configuration();
$config->setApiKey('YOUR_API_KEY');

$template_api = new TemplateApi($config); 
$template_list = $template_api->listTemplates($page = 1);

Java

ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
        
TemplateApi templateApi = new TemplateApi(client);

int page = 1;
TemplateRecords templateList = templateApi.listTemplates(page, null, null, null, null, null, null, null, null, null);

Node.js

import { TemplateApi } from "boldsign";

const templateApi = new TemplateApi();
templateApi.setApiKey("YOUR_API_KEY");

const templateList = templateApi.listTemplates(1);