How Can I Access and Troubleshoot the Addo Sign API?
The Addo Sign API provides a powerful way to programmatically interact with the Addo Sign platform, enabling users to manage documents, signatures, and lists. This article outlines how to access the API, resolve common issues, and understand subscription requirements.
Overview of Addo Sign API Functionality
The Addo Sign Web Service API offers functionality comparable to the platform's user interface. Using the API, you can retrieve and manage data, including lists, by calling the relevant endpoints. Detailed documentation is available to guide you through the available API calls and their parameters. Authentication is required to access the API endpoints.
Access and Subscription Requirements
API Access on Test Accounts
API access is not available on test accounts, and the option to generate an access token will not appear. To use the API, you need at least an Addo Starter subscription on a production account. Alternatively, you can create a demo environment account (demomiljø) where API access is free, though it comes with limitations.
Additional Fees for API Access
API access is not included by default in paid plans and requires an additional monthly fee. Be sure to evaluate this cost when selecting your plan if you need API functionality.
Common Troubleshooting Scenarios
Resolving 401 "Authorization Header Invalid" Errors
A 401 error with the message "Authorization header invalid" occurs when the authorization header is present but not valid for the endpoint being used. Addo Sign’s API prioritizes the Authorization header over a token provided in the request body. Follow these steps to resolve the issue:
If using a login token in the request body: Remove the Authorization header entirely. The body token will then be used.
If using an Authorization header: Ensure it contains a valid user token generated in Webadmin and that the request syntax matches the web service being called.
Avoid token reuse: Do not use the same token value for both the body and the Authorization header, as they are different token types.
After making these adjustments, your requests should succeed.
Demo MitID Credentials in API Requests
Demo MitID credentials are not required in the initial API request (e.g., InitiateSigning). These values are used later during the MitID identification step.
Best Practices for API Usage
Review the Addo Sign Web Service API documentation thoroughly to understand available endpoints and their parameters.
Use a production account with the appropriate subscription level to access all API features.
Ensure proper authentication by using valid tokens and adhering to the API's syntax requirements.
Test your API calls in a demo environment before deploying them in production to minimize errors.
Additional Resources
For more information, refer to the Addo Sign Web Service API documentation and the Addo Sign support portal. By following these guidelines, you can effectively access and troubleshoot the Addo Sign API, ensuring a smooth integration experience.