up

API

The API can be found at: http://api.sendcastle.com/, we attempt to figure out whether you are a human or a machine consuming the API. If you are a human then you will see a rather pretty response and if you are a machine then you will get plain JSON.

We might respond with escaped forward slashes in strings (this is legal JSON, but looks terrible), you do not need to escape yours.

Typical syntax is:
/apiversion/subject/action/identifier/ ... other arguments

An example:
http://api.sendcastle.com/v1/recipient/test/foo

For secure connections (recommended), use, e.g.:
https://www.sendcastle.com/en/api/v1/recipient/test/foo


Extra parameters can go in either the query string (e.g. ?id=123&name=foo) or in the body, JSON-encoded. It is probably recommended to always use json-encoded in the body as some parameters can be rather large (such as a recipients list upload).


Example source code
Examples are available in PHP. If you have other languages that are of interest, please don't hesistate to let us know about use-case and which language. :)

The API is using JSON and is RESTful (with the exception of HTTP status codes) so should be easy to implement in any language using readily available HTTP libraries (such as cURL).

Download PHP Sourcecode
Version: 0.2.3 Last updated: April 28th, 2015


API Access
In order to access the API you need to get a SendCastle API Access Key. You can create secrets by:

  • Log into your SendCastle account at http://www.sendcastle.com/en/dashboard-new
     
  • Click the menu in the top right corner of your SendCastle Dashboard, then go to "Your Account"
     
  • Click "Show Advanced Settings" (new options will now appear)
     
  • Click "Create New Key" at the bottom of the page
     
  • Fill in the little information asked (name and expiration date)
     
  • Click "Save"
     
  • Copy the secret listed (that's your API key) into your source code.
     
  • You are now ready. By using the PHP examples above you can test the key by making a call to SCAPIexamples::test()
Never share or use this secret on the client-side (in e.g. JavaScript); as it grants access to your SendCastle account for anyone who can see it.