Application Programming Interface

API General Documentation

HOW OUR API WORKS

The SC Sage API is managed through RapidAPI. RapidAPI is a part of Nokia. You must have a RapidAPI account to access our API.

We do not allow public API access. All of our access is private and requires invitation to gain access. Invitation is sent through RapidAPI.

API access requires agreeing to our API Terms of Service.

PRICING AND RATE LIMITS

All API pricing and rate limits are customized to the client commitment level.

For purposes of pricing and rate limiting our endpoints are grouped into ‘API’. Each API has pricing and rate limits that apply to all of the endpoints in the group as a group.

ACCESSING OUR API

The following steps are required to access our API endpoint groups.

  • Sign up with RapidAPI as an Organization.
  • Create a Team within the Organization.
  • Provide us with the Organization and Team names.
  • Accept invitations to your Team from SC Sage to the development Test Bed and your custom API Plans in order to access the API/endpoints contracted for.
  • Prior to the start of testing we will provide you with a SC Sage server side API Token and API Secret. These must be submitted in the header of each endpoint request.

This article may prove helpful to navigating RapidAPI. Note that SC Sage does not provide public APIs. Our API’s cannot be accessed without permission.

AUTHENTICATION

We authenticate on the server side using a simple API key token and password secret.

Only we can generate and provide an API token and secret. A user can only have a single valid API token and secret per account.

CACHING OF PROCESSED DATA AND CHART LINKS

We generally do not allow for the saving or caching of Processed Data responses, except for Chart Links, which provisions may change from time to time, with or without notice.

We allow caching of Chart Link responses for a period of up to 24 hours from the response header ‘Date’. At the expiration of the 24 hour period the Chart Link must be deleted from the client side server and a new API request made.

Because we update our data daily, cached Processed Data is stale within 24 hours. Therefore, we delete Chart Links from the server after 24 hours from the response header ‘Date’. As a result cached Chart Links should be deleted and replaced prior to the expiration of the 24 hour period.

VIN PRECHECKING

The VIN is an important parameter for many of our API endpoints as the VIN is used define the specification for the Processed Data and Chart Links. If a VIN is supported by SC Sage, and it is not present in our database at the time of an API request, we will add the VIN to the database at no charge. If a VIN is not supported by SC Sage or is not a valid VIN, the VIN will be rejected, which may result in charges.

For this reason, we do not charge for pre checking a VIN. Submitting a VIN check request allows for a VIN to be confirmed as in the database, or to be added to the database, or to fail as either invalid or not supported. If a VIN fails it should not be used in any other API endpoint requests as this will result in an error which may incur charges.

API ENDPOINT GROUPS AND API PARALLELS

Many of our endpoints in whole or in part replicate applications and charts which are available to paid subscribers of SC Sage.

The following are the API, the included endpoints and their parallel SC Sage apps and charts.

ENDPOINT OVERVIEW

The following are our endpoints and their descriptions.