The RouteLink® API Client allows you to download the Call Routing Number (CRN) routing information from RouteLink (routelink.somos.com). CRNs are frequently referred to as Toll-Free Numbers (TFNs) and are often used interchangeably. The interface between the RouteLink and the RouteLink API Client is REST/JSON. The RouteLink API Client sends HTTPS GET and POST requests to RouteLink. RouteLink responds to the GET or POST with a JSON encoded response. These specifications are intended for the RouteLink API Clients' development team and assumes that they are already familiar with the TFNRegistry™ (tfnregistry.somos.com), TFNs, REST, JSON, and message digests.
Event Queue Order
In general, RouteLink contains an Event Queue with First-In-First-Out (FIFO) events such as “add TFN” and “delete TFN” to be downloaded to a RouteLink API Client, in order. The RouteLink Client requests events to be downloaded. The events MUST be downloaded and processed in FIFO order to guarantee the accuracy of the client's database.
RouteLink API URLs
The following table describes the possible URLs. Each URL is preceded by "/routelink/v1".
| API URLs | |
| URL | Comments |
| /download | Download events from the Event Queue. |
| /initialize | Set the event queue back to an initial download. |
| /audit | Reply to an audit request from the RouteLink application. |
| /refreshToken | Request a new token with a new expiration date. |
| /cpr?sha1= | Request cpr by passing sha1 value which is required. |
| /sessionOpen/sandbox | Request to get a new token when token has expired for a given Sandbox API client. |
| /sessionOpen/live | Request to get a new token when token has expired for a given Production (aka live) API client. |