1. Register (If you have registered API account, please start with Step 2)

Want to make use of the API to integrate to your systems or applications.
Please register an API developer account.

2. Develop

3. Test

In order to use our production API, you have to complete API trial by requesting our API at testing environment using your testing account information at "My Profile" page. Steps for completing API trial:
  • To complete API trial for EC-Ship - Trackable Item API,
    1. Prepare shipping label by requesting Web Service(RESTful) "posting/order" API
    2. Retrieve shipping label PDF by requesting Web Service(RESTful) "posting/order/addressPack" API
  • To complete API trial for Speedpost API,
    1. Prepare shipping label by requesting Web Service(SOAP) "createSoazOrder" API
    2. Retrieve shipping label PDF by requesting Web Service(SOAP) "getSoazAddressPack" API
  • To complete API trial for EC-Ship - Bulk Mailing API,
    1. Prepare posting statement by requesting Web Service(SOAP) "createOrder" API
    2. Retrieve posting statement by requesting Web Service(SOAP) "getPostingStatement" API
  • To complete API trial for EC-Ship - iMail API,
    1. Prepare shipping label by request Web Service(SOAP) "createIMailItem" API
    2. Prepare posting statement by request Web Service(SOAP) "createIMailOrder" API
    3. Retrieve posting statement by request Web Service(SOAP) "getIMailPostingStatement" API
  • Login to API website and upload the generated testing PDF
  • Be informed if the results of the shipping label or posting statement

4. Get certified

  • Upload the application form at "My Profile" Page
  • Be informed if the results of the certification request

5. Go Live

  • Seek consent from owner of the EC-Ship or Speedpost user account in using API to access posting through their accounts
  • Click "API Account Management" in "My Profile" page to add EC-Ship or MySpeedpost user account
  • Email will be sent by our system to the registered email address of the EC-Ship or MySpeedpost user account. They can grant the permission to your API account by clicking the link in the email
  • Once the permission is granted, your API account can be operated at our production API environment
  • Include production key in API calls as authentication credential
  • Include EC-Ship user name or Hongkong Post ID when calling EC-Ship - Trackable Item API, EC-Ship - Bulk Mailing API or EC-Ship - iMail API
  • Include Speedpost user name or Hongkong Post ID when calling Speedpost API