API Documentation

 

API Essentials

API Essentials

This is a quick review of your understanding of not just CorePro, but also where to find relevant information in our documentation site-condensed for busy people.

Understanding the FAQ

The FAQ provides topics that may are relevant to this essentials review. For example, what does CorePro do and not do? Does CorePro Support XML and why aren't webhooks implemented in the system?

Quick summary of Request / Response

The API Request/Response covers important topics regarding your usage of the CorePro API. The topics covered here include Versioning, Data Format Guidelines, Property Naming Guidelines, Common HTTP Response Status Codes, API Call Limit, and Response Format.

Common Mistake #1: Not Handling Throttling 429

API calls are subject to the default limit of 15 requests per second and exceeding this limit will result in all endpoints returning an HTTP status code of 429. Limits are per API key. If the limit is exceeding then the API Key will be blocked for the remainder of the sample period. If an API key continually hits the call limit we reserve the right to permanently block the key and to charge a fee to unblock the key.

To determine the API call amount we monitor the traffic over a sample period. If the traffic results in a particular API key reaching 80% of the limit (i.e., 12 if the limit is 15) over the sample period then the responses will start to contain a throttle node which contains useful information on how close you are to reaching the call limit.

Common Mistake #2: Polling

A common mistake we see developers make is building a for-loop structure around every customer and account on the system. Beyond hitting a 429 error, this will not achieve the result that is needed. We offer two mechanisms to get the data needed, based on the design of your product. One is an AMQP realtime solution and the other is a file feed that provides data extracts in batch. Traffic is metered and because polling is highly discouraged we will identify and contact your development team to make the necessary changes when evidence of this occurs.

Routes

In the left navigational menu is a section API Objects with a list of the available RESTful routes in the CorePro API. The most commonly used routes are Customer, Account, ExternalAccount and Transfer. As you read through the route methods, note that the named actions (e.g., update and create) available on each are consistently named.

Self Assessment


Test your knowledge of these concepts.

1. Which output is supported by the CorePro restful API?

2. What happens if my application exceeds too many requests per second?

3. Is polling ineffective or effective?

4. My application software is posting to /customer/getbysavingsaccount/{accountid}?responseType=xml. What is the expected result?



Ready to start a conversation?

Email Us