API Overview

The PostageApp API uses many of the same standards as other APIs you may be familiar with, as all requests are simple POST requests that accept and return JSON responses. All authentication is via an API key, which is provided for you with each project.

Content Type to JSON

When POSTing to our API, which accepts and returns JSON, be sure to set the Content-Type of your POST request to application/json so that your request can be properly processed.

An easy example using curl that you can drop into Terminal that gives you your account information when successfully submitted.

 curl -v \
 -H "Content-type: application/json" \
 -X POST \
 -d ' { "api_key" : "PROJECT API KEY" } ' \
 https://api.postageapp.com/v.1.0/get_account_info.json

Responses

All responses will typically look like this:

{ "response" : {
    “uid” : “ResponseUID goes here”,
    “status” : “ok”
  },
  "data" : {
    "message” : {
        “id” : “DataID goes here”
    }
  }
}

An error would look like this:

{ "response" : {
    "uid" : “ResponseUID goes here”,
    "status" : "Error of the API call”,
    "message" : "Message of the error”
  }
}

Available Libraries

Official

Unofficial

Recent Discussions

29 Aug, 2014 08:27 AM
18 Aug, 2014 08:33 PM
11 Aug, 2014 12:31 PM
31 Jul, 2014 05:30 PM
29 Jul, 2014 12:21 PM