Introduction

Welcome to the Tatango v2 API! The Tatango v2 API is designed for developers, engineers, or anyone else who’s comfortable creating custom-coded solutions or integrating with RESTful APIS. If you’re not familiar with API concepts like HTTP response codes, REST endpoints, and JSON, try Zapier.

​

Authentication

Tatango authenticates API requests by validating an API key that must be passed with each API call. We use the built-in HTTP basic authentication scheme supported by most HTTP libraries. Use your login email as the username and the API key as the password.

curl -u "your_email@example.com:your_api_key" https://app.tatango.com/api/v2/lists

curl -u "your_email@example.com:your_api_key" https://app.tatango.com/api/v2/lists

require 'net/http'
require 'uri'

uri = URI.parse('https://app.tatango.com/api/v2/example-endpoint')
http = Net::HTTP.new(uri.host, uri.port)
request = Net:HTTP::Get.new(uri.request_url)
request.basic_auth("emailaddress@mydomain.com", "my_api_key")
response = http.request(request)

var request = new XMLHttpRequest();
request.open("POST", "https://app.tatango.com/api/v2/example-endpoint", false);
request.setRequestHeader("Content-Type", "application/json");
request.setRequestHeader("Content-Type", "application/json");
request.setRequestHeader(
  "Authorization",
  "Basic " + btoa("emailaddress@mydomain.com:my_api_key")
);
request.send(null);;

​

Returning multiple results and pagination

By default, GET API calls that return multiple items in a list will return up to 10 items for a single call. The pages_count parameter in the returned JSON will indicate the number of “pages” included in the entire result set. (So for example, if a call to https://app.tatango.com/api/v2/lists finds 27 lists in the system, the JSON will include the following (see JSON snippet below):

{
  "per_page":10,
  "count":27,
  "page":1,
  "pages_count":3
}

To fetch the next page of results, pass the page parameter on the URL, like this: https://app.tatango.com/api/v2/lists?page=2. You can also change the number of records returned in each “page” by passing in a “per_page” parameter as part of the URL, like this: https://app.tatango.com/api/v2/lists?per_page=50.

​

Carrier IDs

This section provides a list of carrier ID and names (US and Canada) for any response that includes carrier and carrierName.

​

United States Carriers

​

Canadian Carriers

​

Errors

The Tatango v2 API uses the following error codes: