SSL/TLS Requirements and Best Practices
To ensure a secure and reliable connection when using the BoldSign API service, it's essential to adhere to specific SSL/TLS requirements. This article outlines the necessary steps and best practices to connect with BoldSign securely.
SSL/TLS Requirements for BoldSign:
1. Minimum TLS Version: To connect with the BoldSign API service, your server must be enabled with a minimum of TLS 1.2. This ensures a secure and encrypted communication channel between your application and BoldSign.
Note: The error message "The request was aborted: Could not create SSL/TLS secure channel" may occur if there's a mismatch in the TLS versions used by the client and server. Ensure that your server meets the minimum TLS 1.2 requirement.
For detailed information on enabling TLS 1.2, consider referring to the "Enable Transport Layer Security (TLS) 1.2" overview in the Configuration Manager on Microsoft Learn.
2. HTTPS is Mandatory: All requests made to the BoldSign API must be transmitted over HTTPS (Hypertext Transfer Protocol Secure) with TLS 1.2 or a higher version. This encryption protocol ensures the confidentiality and integrity of data exchanged between your application and BoldSign.
Best Practices for API Requests:
In addition to meeting the SSL/TLS requirements, it's advisable to follow these best practices when making API requests to BoldSign:
Use JSON Body Format: For most API requests, it is recommended to utilize the JSON body format. Ensure that your API requests specify the
Content-Type: application/jsonheader in the HTTP request. This format enhances the readability and structure of your requests, making them more manageable and easier to troubleshoot.
Character Encoding: When using JSON formatting, ensure that UTF-8 is employed for character encoding. UTF-8 supports a wide range of character sets and ensures compatibility with various languages.
Consider Alternative Body Formats: While JSON is preferred for most API requests, BoldSign offers flexibility by also supporting the regular form-encoded body format for specific methods, such as sending documents or creating templates. Choose the format that best suits your use case.
By adhering to the SSL/TLS requirements and implementing best practices when making API requests to BoldSign, you can establish a secure and efficient integration with BoldSign's electronic signature capabilities. Ensuring that your server supports TLS 1.2 or higher, using HTTPS, and following recommended request formats will help you leverage BoldSign's features while maintaining data security.
If you encounter any issues during the integration process or have further questions, do not hesitate to seek assistance from BoldSign's support.