This article is for existing BlueVolt API users who will need to update their API URLs to utilize the new Developer Portal and avoid any disruption of service.
How to update
Before updating the API URLs and authentication methods, ensure you:
Create an account in the Developer Portal
Request new API Keys corresponding to the APIs you currently use.
Update API URLs and Header requests to use the new URL and primary key.
Updating APIs URLs
For all existing APIs, external systems will need to update their API urls from https://go.bluevolt.com/ to https://apigw.bluevolt.com/.
User Management API
Reporting API
Sales Force API
New API Authentication Method
The developer portal uses a more secure authentication method which includes a Primary Key and API Key. This replaces the previous method which included only an API Key.
Update Header requests
Your new Header requests should include:
Key: ocp-apim-subscription-key
Value: Primary Key
For information about Developer Portal Console authentication visit Getting Started > Primary key vs API key documentation.
Deprecation of old API URLs
To ensure a seamless transition, we will continue to support previous APIs URLs until March 31, 2025. After this date, older API versions will be deprecated and all users are required to migrate to the new versions.
Helpful links
Visit the BlueVolt Developer Portal to register your account.
Update Your APIs Integrations to use the new API URLs and authentication method including Primary + API Keys.
Review APIs Documentation for detailed guides, API specifications and sample requests.