INTRODUCTION
Welcome to the Commercial Services Developer Portal, for Volvo Construction Equipment!
The Volvo Construction Equipment Developer Portal serves as a single gateway that provides easy access to a wide range of services in the commercial sector.
Follow the steps below to gain access and discover how you can start consuming our APIs.
STEP 1: REQUEST YOUR ONBOARDING AND USER CREDENTIALS
Please contact your dealership or your Volvo Construction Equipment representative to request your API integration and onboarding for the developer portal.
The central VCE team will handle your request. Once processed, you will receive an email invitation. To complete your account setup, simply click on the link provided in the invitation email.
On the account creation page, also known as the SIGN-UP page, it is advisable to use your email address when setting up your account on the Developer Portal. Please ensure that your password meets the minimum complexity requirements for it to be accepted.
You will be provided with one or more sets of user credentials. These are used for authorization and authentication processes, and their allocation depends on the specific API you have requested access to.
Please note that these credentials are not used for logging into the Developer Portal.
STEP 2: SIGN IN
Begin by clicking on the ‘Sign In’ link located in the upper right corner to log in.
Before inputting your account name and password, ensure that the correct user registry is selected.
Verify if the default use registry is set to 'Developer' (this is confirmed if the message 'Sign in with Developer' is displayed on the left side of the screen).
If it is not the case, select the Developer user registry on the right part of the screen.
You have now to Sign in with your Volvo Construction Equipment credentials.
After you’ve logged in, you have the ability to invite additional members to the Developer Portal. You can also assign them specific roles such as administrator, developer, or viewer, depending on your requirements.
STEP 3: FIND YOUR API KEY & SECRET
API keys serve as identifiers for your application(s). To locate your API keys, follow these steps:
1. Go to the main menu and choose ‘Apps’. Here, you’ll see any applications that have already been created.
2. Select the appropriate application, then select ‘Subscriptions’. Here, you can copy the API Key. Note that the API Secret is only shown when the app is first created.
3. You can have multiple sets of credentials for each application. To create a new set, click ‘Add’.
4. If the application doesn’t exist, you can create a new one using the standard naming convention (AEMP-name of ConsumerOrg) and save the credentials.
Please note that it’s advisable to have a separate application for each API.
STEP 4: SUBSCRIBE TO A PLAN
Browse through the API Products. Each product is comprised of one or more APIs. Every API has a dedicated documentation page where you can find in-depth technical information.
Find the API product that suits your needs and subscribe to one of the available plans for that product.
If the product offers the option to subscribe to both a TEST and a PRODUCTION PLAN, it's recommended to begin with the TEST plan first.
Subscribing will grant your application the necessary permissions to access all the APIs within the chosen product.
After conducting some tests and ensuring your application is functioning properly, you should then subscribe to a PRODUCTION PLAN for the same product. This plan offers a higher rate limit, making it more suitable for production requirements.
STEP 5: AUTHORIZATION AND AUTHENTICATION
When executing an operation, you'll need to supply an API key, a Secret, and a Bearer Token that represents the end user's identity.
The implementation of these elements can vary based on the specific product.
Additionally, you may need to implement certain authorization prerequisites in other systems.
YOU ARE NOW READY TO TEST OUR APIs!
Subscription Cancellation
To cancel your subscription, send a cancellation request to support.vcif@volvo.com.
The email address used for this request must be the email address that is used to connect to the developer portal. You must also specify for which subscription(s) you want to cancel.