STEP 1: REQUEST YOUR ONBOARDING AND OBTAIN YOUR USER CREDENTIALS

Please contact your dealership or your Volvo Construction Equipment representative so they can request your API integration and your onboarding in the developer portal.

The central VCE team will take care of the request and you will receive an invitation by email. Click on the link (or copy and paste the text of the link) in the invitation email to finalize your account creation.

In the account creation page (also called SIGN UP), we recommend you to use your email address as your account in the developer portal. The password should respect minimum complexity to be accepted.

You will also receive set(s) of user credentials used in the authorization and authentication flow, depending on which API you have asked for. These sets of credentials are not used to connect to the developer portal.

STEP 2: SIGN IN

Start by signing in using the Sign In link in the top right corner.

Before you enter your account name and password, you need to select to correct user registry. Check if the default user registry is correct (the message: “Sign in with Developer” is displayed on the left column). 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.

Once signed in, you can invite more members to the developer’s portal and assign specific roles of administrator, developer or viewer as per your need.

At this point, all the members of the consumer organization have access to the API documentation.

Explore the API Products, each product consists of one or several APIs. Each API has its own API documentation page where you can find more technical details.

STEP 3: FIND YOUR API KEY

API Client IDs are used to identify your consuming application(s). To find your API Key, here’s what you need to do:

In the main menu select Apps and then you will find the application that has been created for you.

Select the relevant application (one application will be created per API).

Then navigate to Subscriptions and click on the Show box to display the Client ID.

STEP 4: SUBSCRIPTION

A subscription is created for your app(s) depending on what you have chosen during the ordering process.

The subscription will authorize your App to call all the APIs in the selected Product.

Once you have perform some tests and your application is operational, then you will have to subscribe to one of the plans that will have a higher rate limit, more adapted to production constraints.

STEP 5: AUTHORIZATION AND AUTHENTICATION

When you call an operation, you will have to provide an API key and a Bearer Token that holds the identity of the end user.The way it is implemented can differ depending on the product. You may have also to check some authorization prerequisite to be implemented in other systems.

So check in the product documentation the authentication / authorization part.

YOU ARE NOW READY TO TEST OUR APIS!

IF YOU WANT TO CANCEL YOUR SUBSCRIPTION

As a consumer of one or several of our Volvo APIs, you can cancel services at any time by one of two ways:

1.    Via the developer's portal. You need first to login and then open the APP list in the APP menu. Select the APP for which you want to remove the subscription. Go to the subscription section and then click on the 3 dots at the right part of the subscription. Then click on Unsubscribe.

2.    An email can be send to support.vcif@volvo.com requesting for the subscription to be cancelled. The sender of the email must be one of the email used to connect to the developer portal. You need also to specify for which Product you want to remove the subscription(s).