Getting Started

Pitney Bowes APIs are designed to be smart and simple to use. We have made it easy for you to browse our APIs and test drive the showcase apps without signing up for an account. Sign in or register for a Pitney Bowes Developer Account. This account will give you access to APIs as well as comprehensive usage reporting and statistics.

 

How to get your API Key

 

  1. Register for a Pitney Bowes Developer Account. No credit card required.
  2. Sign in with your Developer Account and select My Account in the account menu in the upper right.
  3. You will see your API key and secret listed underneath the API usage report.

 

Once you have registered or logged-in, follow the steps below to make your first API call:

  1. Encode the API key and Secret using base64 encoding. Use ({YOUR API KEY}:{YOUR SECRET}) format for encoding.


  2. To get an access token, set header and request body and call the token URI:
  3. Authorization: Basic {BASE64 ENCODED VALUE}
    Content-Type: application/x-www-form-urlencoded
    POST https://api.pitneybowes.com/oauth/token
    grant_type=client_credentials


  4. The access token is returned as:
    {
    "access_token": "{YOUR ACCESS TOKEN}",
    "tokenType": "BearerToken",
    "issuedAt": "1429188455329",
    "expiresIn": "35999",
    "clientID": "{YOUR API KEY}",
    "org": "api.pitneybowes.com"
    }


  5. To call the Location Intelligence API, set header and call API URI:
    Authorization: Bearer {YOUR ACCESS TOKEN}
    GET http://api.pitneybowes.com/location-intelligence/geosearch/v1/locations?latitude={YOUR_LATITUDE}&longitude={YOUR_LONGITUDE}&searchText={YOUR_SEARCH_TEXT}

     

    For more information, refer to the Online Developer’s Guide.



  6. To call the Customer Information Management API, set header and call API URI with your input data:
    POST https://api.pitneybowes.com/identify/identifyaddress/v1/rest/validatemailingaddress/results.json HTTP/1.1
    Content-Type: application/json
    Authorization: Bearer {YOUR ACCESS TOKEN}
    Host: api.pitneybowes.com
    {
    "options": {
    "OutputCasing": "M"
    },
    "Input": {
    "Row": [
    {
    "AddressLine1": "",
    "AddressLine2": "",
    "City": "",
    "Country": "",
    "StateProvince": "",
    "PostalCode": "",
    "FirmName": ""
    }
    ]
    }
    }

     

    For more information, refer to the Online Developer’s Guide - SOAP / REST.