Introduction

Welcome to the Streampoint API Documentation!

Use the documentation on this site to learn how to implement services to pull registration data from the Streampoint system. Information on attendee, exhibitor and speaker registrations are available to be requested. Currently, our API offers read-only access to the system.

To date, we provide language bindings in C# only. You will find code samples to the right and can switch between languages using the tabs at the top as they become available. Please note that all code snippets provided are for reference and illustration purposes only. They are to show you how to format requests and what kind of data to expect in return. Simply using the code as is may not work out of the box.

If you have any questions, feel free to contact us at api@streampoint.com

Getting Started

Streampoint offers REST access to our systems through two endpoints. Each environment is given separate credentials, use the appropriate keys to access the test and production environments accordingly. To get started today, please contact api@streampoint.com to request a developer account.

UAT (Testing) Environment:

REST: https://apireststaging.streampoint.com/v1/personal.svc

Production Environment:

REST: https://apirest.streampoint.com/v1/personal.svc

Authentication

Authentication to the API is made using HTTP Basic Auth. Every request your application makes to the Streampoint API must include your API keys for authentication.

REST Authentication

const string token = "TOKEN GOES HERE";
const string baseUrl = "https://apireststaging.streampoint.com/v1/personal.svc";
const string dataPullEndpoint = "DATA ENDPOINT GOES HERE";

var pullRequest = (HttpWebRequest)WebRequest.Create(baseUrl + dataPullEndpoint);
pullRequest.Method = "GET";
pullRequest.ContentType = "application/json";
pullRequest.KeepAlive = false;
pullRequest.Timeout = 3600000;
pullRequest.Headers.Add("x-auth-token", token);

const token = "TOKEN GOES HERE";
const baseUrl = "https://apireststaging.streampoint.com/v1/personal.svc";
const dataPullEndpoint = "DATA ENDPOINT GOES HERE";

pullRequest = curl_init(baseUrl . dataPullEndpoint); 
curl_setopt($pullRequest, CURLOPT_HTTPGET, true);
$header = array();
$header[] = "Content-type: application/json";
$header[] = "x-auth-token: " . token;
curl_setopt($pullRequest, CURLOPT_HTTPHEADER, $header);
curl_setopt($pullRequest, CURLOPT_FORBID_REUSE, true);
curl_setopt($pullRequest, CURLOPT_TIMEOUT, 3600);
curl_setopt($pullRequest, CURLOPT_RETURNTRANSFER, true);

Using this implementation, you will need to authenticate by providing an authorization token.

Please refer to the code sample to the right.

Person (Lead Retrieval)

This is an object that represents a single registrant.

Properties

Get Person By ConfirmationId

REST Request Example

public void GetPersonByConfirmationIdExample()
{
    const string token = "TOKEN GOES HERE";
    const string baseUrl = "https://apireststaging.streampoint.com/v1/personal.svc";
    const string dataPullEndpoint = "/LeadRetrieval/GetPersonByConfirmationId";
    string parameters = "?confirmationId=99999123";

    var pullRequest = (HttpWebRequest)WebRequest.Create(baseUrl + dataPullEndpoint + parameters);

    pullRequest.Method = "GET";
    pullRequest.ContentType = "application/json";
    pullRequest.KeepAlive = false;
    pullRequest.Timeout = 50000;
    pullRequest.Headers.Add("x-auth-token", token);

    var pullResponse = (HttpWebResponse)pullRequest.GetResponse();
    var reader = new StreamReader(pullResponse.GetResponseStream(), Encoding.UTF8);

    //De-serialize the JSON data into useful objects

    var ser = new DataContractJsonSerializer(typeof(Person));

    var results = (Person)ser.ReadObject(reader.BaseStream);
    //At this point results contains the person, if the confrimation Id was valid.
}

function getPersonByConfirmationIdExample()
{
    const token = "TOKEN GOES HERE";
    const baseUrl = "https://apireststaging.streampoint.com/v1/personal.svc";
    const endpoint = "/LeadRetrieval/GetPersonByConfirmationId";

    const parameters = "?confirmationId=99999123";

    $pullRequest = curl_init(baseUrl . endpoint . parameters);
    curl_setopt($pullRequest, CURLOPT_HTTPGET, true);
    $header = array();
    $header[] = "Content-type: application/json";
    $header[] = "x-auth-token: " . token;

    curl_setopt($pullRequest, CURLOPT_HTTPHEADER, $header);
    curl_setopt($pullRequest, CURLOPT_FORBID_REUSE, true);
    curl_setopt($pullRequest, CURLOPT_TIMEOUT, 3600);
    curl_setopt($pullRequest, CURLOPT_RETURNTRANSFER, true);

    $response = curl_exec($pullRequest);
    curl_close($pullRequest);

    //De-serialize the JSON data into useful objects
    $results = json_decode($response);

    //At this point results contains the data set
    print_r($results);
}

REST Response Output

{
    "Address1": "987 S. Michigan Ave",
    "Address2": "Suite 1001",
    "AlternateEmail": null,
    "Association": "Streampoint Solutions",
    "BadgeID": null,
    "BadgeName": null,
    "City": "Chicago",
    "ConfirmationNumber": null,
    "Country": "United States",
    "Demographics": null,
    "Email": "john.test@streampoint.com",
    "Fax": null,
    "FirstName": "John",
    "Guests": null,
    "LastName": "Smith",
    "Membershipcode": null,
    "PPID": null,
    "Payment": null,
    "Phone": "789-456-1234",
    "Prefix": null,
    "Profile": null,
    "ProvState": "Illinois",
    "Questions": null,
    "RegType": null,
    "Seminars": null,
    "Title": "Practitioner",
    "Zip": "11111"
}

Returns an individual registration record based on their confirmationId.

Request Parameters

Returns

A Person object

Endpoint

/LeadRetrieval/GetPersonByConfirmationId