Partner API Migration
What’s changing?
Section titled “What’s changing?”Currently, the Partner API requires a locally-installed COM DLL file to function, as well as a complicated activation and user onboarding process. The new API will be accessed by standard HTTP endpoints, secured using OAuth token authentication and will be platform-agnostic, meaning it can be used from any programming language or environment that supports HTTP requests.
Why should I migrate?
- Modern standards: HTTPS and token-based security.
- Cross-platform compatibility: Use the API from any programming language, operating system or environment.
- Simplified onboarding: No more complex DLL installations and activations.
- Improved scalability & maintainability: Designed for modern development practices, making it easier to scale and maintain.
- Get ahead of the curve: Migrating now ensures continuity and avoids service disruption when the current API is deprecated.
How do I authenticate with the new API?
Section titled “How do I authenticate with the new API?”Refer to the Authentication documentation for details on how to authenticate with the new API.
Are the function names and parameters the same?
Section titled “Are the function names and parameters the same?”Yes, where possible we have kept the function names and parameters the same to make migration easier.
A full list of available endpoints can be found in the API documentation.
What about error handling?
Section titled “What about error handling?”We are returning the original vOutcome in the error response to ease migration work, but the main error response has been changed to use standard HTTP status codes:
- 200 OK for successful requests
- 400 Bad Request for invalid inputs
- 401 Unauthorized for authentication errors
- 500 Internal Server Error for unexpected errors
What tools/libraries can I use with the new API?
Section titled “What tools/libraries can I use with the new API?”The new API is designed to be platform-agnostic, meaning you can use any HTTP client library available in your programming language of choice. Some popular libraries include:
- JavaScript/TypeScript: Axios, Fetch API
- Python: Requests, httpx
- C#/.NET: HttpClient, RestSharp
You can also use tools like Postman or cURL to test the API endpoints directly.
How do I report issues or get help?
Section titled “How do I report issues or get help?”We will be providing several options for support as we roll out the new API, which will be detailed in due course.