Context

This guide explains how to upgrade between versions of the Hostfully PMP API, with step-by-step instructions and best practices to ensure a smooth transition.

Overview

Hostfully PMP API upgrades are incremental, meaning you must follow the sequence of versions when upgrading. For example, to move from v3 to v3.2, you must first upgrade to v3.1.

Upgrade process

Example: Upgrading from v3 to v3.1

Follow these steps to upgrade your API version:

Initiate the Upgrade in Sandbox
Send a PUT request to the migration endpoint in the sandbox environment. Ensure you use basic authentication header.
1. Curl:
```
curl --request PUT 'https://sandbox.hostfully.com/api/version' \
--header 'Authorization: {clientId}:{clientSecret}'
```
1. Refer to the API reference for detailed endpoint information.
Update Endpoints and Implement Changes
Update all your API endpoints to their v3.1 counterparts. Review the v3.1 API documentation to understand the required changes and ensure compatibility.
Test in Sandbox
Verify that your system works correctly with the updated endpoints and the new API version in the sandbox environment.

Go Live
After confirming everything works in sandbox, repeat steps 1 using the production environment:

curl --request PUT 'https://api.hostfully.com/api/version' \
--header 'Authorization: {clientId}:{clientSecret}'

Upgrading to Subsequent Versions

Please refer to this guide for migrating to API 3.2.