Campaign Kit API Root Endpoint

This describes the resources that make up the official Campaign Kit API v1. If you have any problems or requests please contact support. Issue a GET request to the root endpoint to get a list of all the resource endpoints this API supports.

Headers

Authorization

The API Key is passed via the Authorization header:

Authorization: Token token="secret"

The API Key is associated with your account and has access to all the resources associated with your account. Account specific API keys have different permissions than the web login users that can interact with the dashboard, and the access may be different.

If you do not have an API key, you can create one here.

Note: Per RFC 2616 the Authorization Header's token needs to be surrounded by double quotes (").

Content Type

The content type is vnd.rn+json and should be set in the Content-Type header:

Content-Type: application/vnd.rn+json

Requesting Resource Endpoints 

GET /api/v1

Response 

Status: 200 OK
Content-Type: application/json; charset=utf-8
CampaignKit-Media-Type: campaignkit.v1
CampaignKit-API-Version: 1.0

{
  "links": {
    "users.kits": "https://campaignkit.radiusnetworks.com/api/v1/kits/{users.kits}",
    "kits.places": "https://campaignkit.radiusnetworks.com/api/v1/places/{kits.places}",
    "kits.campaigns": "https://campaignkit.radiusnetworks.com/api/v1/campaigns/{kits.campaigns}",
    "kits.contents": "https://campaignkit.radiusnetworks.com/api/v1/contents/{kits.contents}",
    "kits.assets": "https://campaignkit.radiusnetworks.com/api/v1/assets/{kits.assets}"
  }
}

Curl Example 

curl https://campaignkit.radiusnetworks.com/api/v1 \
  -is \
  -X GET \
  -H 'Accept: application/vnd.rn+json' \
  -H 'Content-Type: application/vnd.rn+json' \
  -H 'Authorization: Token token="c0decafe1111180a29c8696adbd5307ccdcdaa6468c0ffee"'