Where can I start building my first application integrated thru Connected Cloud API?

It’s normal, this is your first integration, you’ve never heard before about this API and you don’t know what do you need to start developing neither what should be the first steps you should follow.

Don’t worry! We’re here to help and guide you through this simple integration path.

First of all, let’s clarify what the Connected Cloud API is: It provides a consistent method for connecting your new apps and developments to a Sage 50cloud, Sage 200cloud or any other Sage connected-cloud application. The key concept for this API is based on the simple principle of sharing files, where each one contains application data conforming to a relevant predefined solution schema.

Start developing for Cloud Connected API doesn’t have any special requirement, although it would be worth to have a Sage application available to make some tests.

You should start obtaining your credentials, so for getting them you must proceed registering as a developer following some simple steps:

  1. Use this link to download a Postman collection file where you’ll find all the API operations provided available to start using it. If you still don’t have it, we encourage you to download the Postman desktop version from here.
  2. Open the Postman collection file you’ve just downloaded and go for the “Developers” subfolder under the “Sage Connected Cloud API” in the left menu bar. There, the first "POST application" you’ll found is to create a new developer account. Click on it and replace all the fields in the “Body” section with your personal developer details, as well as with all the information requested to register the application you’re going to create. Take special note with the string used for the “domain” field: it should be one available from the Solutions section on the Developer Portal.
  3. Once all the fields completed, click the “Send” button to invoke the operation. You’ll receive a URL in the response body. Take the URL from the bottom part of the screen in Postman and use it on your favourite web browser.
  4. You will be presented with a regular captcha web page. This is just to be sure you are not a robot.
  5. Once successfully completed, you will receive your credentials (Developer Id and Application Id) by email through the account provided on step 1.

Now, you can create passcodes that should be used within the Sage product you want to integrate with. Once entered and granted permissions, you’ll receive the API key required to start uploading (Sage data ingestion) and downloading (Sage data delivery) information to make your integration work.

For further details, don’t forget to visit the Connected Cloud section of the Developer Portal.