Best Practices
Before Development
Comprehensive Understanding
Before beginning development, ensure you have a comprehensive understanding of DottedSign and DottedSign API. Exploring and testing DottedSign will help you understand its electronic signature landscape, including the features it offers and the signing workflows it supports. DottedSign API is an integration solution based on the operational logic of DottedSign, offering users more options to customize their application scenarios. For more detailed information, please refer to the API References and Webhook sections.
Optimal Development Environment
After familiarizing yourself with DottedSign API, the next step is to prepare your development environment. Make sure that your environment meets the DottedSign Requirements. This preparation should include verifying any language-specific requirements or version compatibilities that might impact your integration.
During Development
Throughout the development process, it is crucial to adhere to the instructions for each API. Additionally, consider the following recommendations to ensure a smooth integration.
Utilizing Sandbox
Coming soon.
Utilizing Examples
DottedSign API provides two types of documentation: API References and Postman collections. Both documents offer complete schema formats and a variety of examples for guidance. Furthermore, the Quick Start Scenarios page features several common signing scenarios, illustrating how to integrate various APIs effectively.
Thorough Testing
After development, it's crucial to conduct thorough regression testing before launching. Pay careful attention to handling various potential errors to prevent issues that could arise from varying factors, such as user settings, user's pricing plan, group permissions, or other operational settings.
Security & Performance Considerations
- Use HTTPS: Always secure your API requests with HTTPS to protect data during transmission.
- Store your authentication tokens securely: DottedSign API offers multiple authentication and authorization methods. Ensure your
client_secret
and any tokens obtained are never exposed in any client-side code or public repositories, and are securely stored. - Rate Limiting: Be mindful of Rate Limits and implement exponential backoff strategies to manage requests effectively and avoid service disruptions.
After Development
Staying Updated
Regularly check for updates from DottedSign and review DottedSign API Changelogs to ensure compatibility with new features or changes in API behavior. This periodic review is essential to maintaining alignment with your evolving application.
Collaboration and Feedback
Encourage ongoing communication between your development team and DottedSign support to refine integration and address any challenges promptly.
Updated 4 months ago