Route API  

The Route API is built around industry standard REST. Our API has predictable, resource-oriented URLs, and uses intuitive human readable API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. JSON is returned by all API responses, including errors. All API calls include postman scripts for easy testing and experimentation.

To make the API as explorable as possible, accounts have test mode and live mode API keys. There is no “switch” for changing between modes, just use the appropriate key to perform a live or test transaction. Requests made with test mode credentials incur no cost and are meant to be permeate parameters of your development and test environments.

There are six keys in all. The intended use of each key is defined here, in individual API documents and in the administration section of your Dashboard. Each key has an identifier to make it easy to know where the key belongs.

Key Identifier Age
Live API Key LIVE_ak_ (ak = API Key) PRIVATE: Never share or hard-code. Part 1 of 2 used to authenticate LIVE API requests.
Live Secret Key LIVE_s_ (s = Secret) PRIVATE: Never share or hard-code. Part 2 of 2 used to authenticate LIVE API requests.
Live Widget Key LIVE_wk_ (wk = Widget Key) PUBLIC: Used to identify Route Widget owner. Designed to be used in UI code.
Test API Key test_ak_ (ak = API Key) PRIVATE: Never share or hard-code. Part 1 of 2 used to authenticate test API requests.
Test Secret Key test_s_ (s = secret) PRIVATE: Never share or hard-code. Part 2 of 2 used to authenticate test API requests.
Test Widget Key test_wk_ (wk = Widget Key) PUBLIC: Used to identify Route Widget owner. Designed to be used in UI code.

Your API Keys and Secret Keys carry many privileges, so be sure to keep them secret! Do not share your API Keys or Secret Keys in publicly accessible areas such GitHub, client-side code, and so forth.