Skip to content
logo Knowledgebase

Sage 200 API - Guide to Sage ID Changes

Created on  | Last modified on 

Summary

A guide to updating your existing Sage 200 API 3rd party applications to use the new Sage ID authentication method.

Description

As previous communicated, see here, Sage ID is transforming to support new standards such as JWT and Open ID and will replace our current Sage ID offering. The new version of Sage ID is not backward compatible with the existing in market version of Sage ID and therefore any applications that use this technology will need to be upgraded.

Therefore, any third party addons that you have developed using the Sage 200 API will need to be updated prior to 19th February 2021 to make use of the latest version of Sage ID and avoid a loss of service.

This article details the steps required to convert your existing Sage 200 API applications to use our new Sage ID authentication method.

Resolution

Request New Credentials:

Due to the nature of the Sage ID changes, your existing Sage 200 API credentials will not work with the new authentication method. You will, therefore, need to request new credentials for your development and production environments.

CAUTION: Development credentials are only intended for development /testing purposing, whilst Production credentials must only be deployed in a live production environment.

You do, however, need to request separate credentials for Sage 200 Standard Online and Sage 200 Extra Online/Professional, as was previously the case, as the same credentials can now be used for both products.

Please complete our Sage 200 API Credentials Request Form to request your new Sage 200 API client credentials.

NOTE: Please complete multiple instances of the form if you require more than one set of credentials i.e. Development/Production or Public(Desktop)/Confidential(Web). 

Applications Changes:

In addition to updating your application’s API client credentials, you will need to update your application’s source code to make use of the new authentication method. These changes will vary based on your application has been developed, Desktop (Public) or Web (Confidential).

We have updated our Sample Application (version 4.0.0), Client Library and documentation to demonstrate these changes. These can be found here.

Note: Sage Developer Services will support with the generation of API client credentials, however, we do not support implementation, debugging/troubleshooting that make use of the Sage 200 API, or Sage ID, programmatically.

Additional Resources:

Endpoint documentation, including sample application and client library, can be found here.

Knowledge base articles produced by Developer services for the Sage 200 API can be found here, including our Common Queries and Frequently Asked Questions article.

Our guide to querying the Sage 200 API using Postman has been updated to reflect the new authentication method and can be found here.