Active Calendar

Main Page

RSS

Event Publisher API


Top

Introduction

Event Publisher's API is a RESTful HTTP API, meaning all API functions are called using a URL request and response. To request data from the API, you can call a Web URL using your favorite browser or programming language, and the API will return back data to you in the format you specified. This document outlines the requirements for generating an API URL, the different types of URLs, and the responses you will receive.


Top

Getting Started

Working with the API for Event Publisher requires a User account, with access to the API Configuration Site Setting. Additionally, you will need to create an API Application Token, and API Client Secret Key.



How It Works

The URL below outlines the basic requirements to create an API request.


http://api.activecalendar.com/format/entity/param/?token=application-token&secret=client-secret

Top

URL Parts

The following components should be included in all URL's that are making requests. Unless noted all fields below are requried.

  • domain
    • All API requests point to a single endpoint, api.activecalendar.com, for processing.
  • format
    • XML
    • JSON
  • entity
    • events
    • event
    • categories
    • locations
  • param
    • Query Type: Optional. URL parameters are used to further define an API request based on the entity.
  • Query
    • token
    • secret

Top

Authentication

All API requests need a client token and one of the following: secret query parameter, or authorized domain, to successfully receive a response from the API. These parameters are the most cryptic and verbose part of the request URL and can easily cause the format of URL to become invalid. The API will not process requests unless authenticated by the {token/secret} or {token/domain}. The API will always produce a response, in the event that your request is unauthorized, the response produced will be, "Unauthorized".



Make sure the Client Token, Client Secret Key or authorized domain, are correct when creating or generating your request URL, and then add query parameters to the URL.


  • Use the Client Token and Secret Key:


  • token=MzI0NzFkZDAtZDZmMC00NTI1LWJhZ&&&&&&zExZWQtNDAzZC00ZjQ3LWIxYmMtZGMwNmQ4MjcxNWFh 
    secret=OWVmNTNlMzItNzljNS00ZjgwLWJm&&&&&&jYzAxNg4YTQymEtN2Q2YS00MzjQtMzA1ZDE4Nzg1Njhk

  • Use the Client Token and Authorized Domain: if you have configured a value in the "BASE URL" field in the API configuration menu in Event Publisher you can exclude the secret key from the URL. Only requests sent from your BASE URL will be authorized.


  • token=MzI0NzFkZDAtZDZmMC00NTI1LWJhZ&&&&&&zExZWQtNDAzZC00ZjQ3LWIxYmMtZGMwNmQ4MjcxNWFh 


Top

Formats

Event Publisher's Web API requires you to specify the format in which you would like to receive your response. This is a required format and must be one of the below options.


Top

xml

Specifying xml in the URL will return the requested data in XML format. The value xml in the URL must be lowercase.

json

Specifying json in the URL will return the requested data in JSON format. The value json in the URL must be lowercase.


Entities

You can request the following items (entities) via the API:

  • Events (multiple)
  • Event (singular).
  • Categories
  • Locations


Top

Events

The events entity will return a list of event data based on the search parameters in the URL. The URLS's above (once actual tokens and secrets are added) will pull back a week's worth of event data from the calendar. The parameters below allow for pulling back events matching the exact criteria specified.



Visit the Events Page here


Top

Event

The event entity will return a list of event data based on the search parameters in the URL. The parameters below allow for pulling back events matching the exact criteria specified.



Visit the Event API Page here


Top

Categories

The categories entity will return a list of categories used by a calendar site.



Visit the Categories API Page here


Top

Locations

The locations entity will return a list of active locations.



Visit the Locations API Page here


Top