CitySpark API

Introduction

Provides an API for getting event and event-related information from the CitySpark platform

API	Description
GET v1/categories	Gets the event categories

Events

API	Description
GET v1/events	Gets a list of events from the parameters provided
GET v1/event/{eventId}?portal={portal}&descriptionFormat={descriptionFormat}	Gets a single event from an event identifier

Promotions

API	Description
GET v1/Promotions/Flat?portal={portal}&asOfDate={asOfDate}&startDate={startDate}&numberOfDays={numberOfDays}	Gets a list of promotions for a portal, supports the csv format

Users

API	Description
GET v1/Users/Flat?portal={portal}	Gets a list of users from the parameters provided, supports the csv format
GET v1/User/Exists?email={email}	Used to see if a user exists in the system for a given Email. Returns any known information about the user.
GET v1/Users?portal={portal}&includePromotions={includePromotions}&includeSubmissions={includeSubmissions}&startDate={startDate}&numberOfDays={numberOfDays}	Gets a list of users from the parameters provided

Authentication

The API supports Basic Authentication as defined in RFC2617 using a username and password

To use Basic Authentication with the CitySpark API, simply send the username and password associated with an API account.

For example, if you’re accessing the API via cURL, the following command would authenticate you if you replace 'username' with your username. (cURL will prompt you to enter the password.)


            $ curl -u username -k https://api.cityspark.com/v1/events?portal=myPortalSlug&format=xml&handPicked=true

C# Scripting Example

            #! "netcoreapp2.0"
            #r "System.Net.Http"
            using System.Net.Http;

            HttpClient client = new HttpClient();
            var byteArray = Encoding.ASCII.GetBytes("Username:Password");
            client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Basic", Convert.ToBase64String(byteArray));

            HttpResponseMessage response = await client.GetAsync("https://api.cityspark.com/v1/Users?portal=YourSlugHere");
            var content = await response.Content.ReadAsStringAsync();

Ruby Example

            require 'uri'
            require 'net/http'
            require 'io/console'

            uri = URI.parse("https://api.cityspark.com/v1/events?portal=YourSlug")

            http = Net::HTTP.new(uri.host, uri.port)
            http.use_ssl = true
            request = Net::HTTP::Get.new(uri.request_uri)

            request.basic_auth("usernameHere", "passwordHere")
            response = http.request(request)
            json = response.body