API Keys Documentation API Methods Error Codes OAuth 2 Doc

ZapEvent API Keys


Register Your Application

If you have a ZapEvent account, you can register your application to take advantage of our OAuth authentication.
This allows you to securely access user information via the API. To get started, register your application below.

OAuth Details

Request Token Endpoint:  https://www.zapevent.com/api/oauth/RequestToken
OAuth Login URL:  https://www.zapevent.com/api/oauth/Authorize
Access Token Endpoint:  https://www.zapevent.com/api/oauth/AccessToken

Your Registered Applications

Please Sign In to register/view your applications.
×

ZapEvent API Documentation

ZapEvent API can be accessed by using one of the following methods:
  • - Login Method
  • - OAuth Authorization and Authentication Method

Login Method

Login method allows the consumer to provide the ZapEvent Login credentials (username and password) for accessing the ZapEvent API. This will return the temporary key and temporary secret and shall use in API Calls to access the data.

OAuth Authorization and Authentication Method

Step 1- POST oauth/RequestToken

Allows a Consumer application to obtain an OAuth temporary token to request user authorization. This method fulfills Section 6.1 of the OAuth 1.0 authentication flow.

It is strongly recommended you use HTTPS for all OAuth authorization steps.

Usage Note: Only ASCII values are accepted for the oauth_nonce

Resource URL
https://www.zapevent.com/api/oauth/RequestToken
Parameters
OAuth parameters are always sent the same way as other parameters. If you're using HTTP-header based OAuth, you shouldn't include oauth_* parameters in the POST body or querystring.
  •   Parameter Name
  •   Value Description
  • oauth_consumer_key
  • The identifier portion of the client credentials provided by the server.
  • oauth_nonce
  • a random string, uniquely generated by the client. (Omit in PLAINTEXT Signature method)
  • oauth_timestamp
  • MUST be a positive integer and is expressed in the number of seconds since January 1, 1970 00:00:00 GMT. (Omit in PLAINTEXT Signature method)
  • oauth_callback
  • URL (query parametrs)/encoded URI (Authorization Header) back to which the server will redirect the resource owner when the Resource Owner Authorization step is completed.
  • oauth_signature_method
  • The name of the signature method used by the client to sign the request. (HMAC-SHA1/PLAINTEXT)
  • oauth_signature
  • The client calculates and assigns the value of the "oauth_signature" parameter as described in Section 3.4 of RFC5849 specification.
  • oauth_version
  • OPTIONAL. If present, MUST be set to "1.0".

Example Request

Request URL:
POST https://www.zapevent.com/api/oauth/RequestToken

Request POST Body:
N/A

Authorization Header:
OAuth oauth_nonce="638937701", oauth_callback="http%3A%2F%2Fmyapp.com%3A3005%2Fzapevent%2Fcallback_process", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1300228849", oauth_consumer_key="8493b95910d748c99bf74e61ef12043f", oauth_signature="Pc%2BMLdv028fxCErFyi8KXFM%2BddU%3D", oauth_version="1.0"

Response:
oauth_token=b51d543ead3b43d69fae0ab35101eea6&oauth_token_secret=471B0501CF909941547B37F2F6C795059FAC26AF&
oauth_callback_confirmed=true

Step 2- GET oauth/authorize

Allows a Consumer application to use an OAuth Request Token to request user authorization. This method fulfills Section 6.2 of the OAuth 1.0 authentication flow.

Please use HTTPS for this method, and all other OAuth token negotiation steps.

Usage Note: An oauth_callback is never sent to this method, provide it to POST oauth/RequestToken instead.

Resource URL
https://www.zapevent.com/api/oauth/authorize
Parameters
OAuth parameters are always sent the same way as other parameters. If you're using HTTP-header based OAuth, you shouldn't include oauth_* parameters in the POST body or querystring.

Example Request

Send the user to the oauth/authorize step in a web browser, including an oauth_token parameter:
https://www.zapevent.com/api/oauth/authorize?oauth_token=b51d543ead3b43d69fae0ab35101eea6

Request POST Body:
N/A

Authorization Header:
N/A

Response:
oauth_token=b51d543ead3b43d69fae0ab35101eea6&oauth_verifier=76bb1c1c95464e5cbd2af1c0617467c3

Step 3- POST oauth/access_token

Allows a Consumer application to exchange the OAuth Request Token for an OAuth Access Token. This method fulfills Section 6.3 of the OAuth 1.0 authentication flow.

Please use HTTPS for this method, and all other OAuth token negotiation steps.
Resource URL
https://www.zapevent.com/api/oauth/AccessToken
Parameters
OAuth parameters are always sent the same way as other parameters. If you're using HTTP-header based OAuth, you shouldn't include oauth_* parameters in the POST body or querystring.
  •   Parameter Name
  •   Value Description
  • oauth_consumer_key
  • The identifier portion of the client credentials provided by the server.
  • oauth_nonce
  • a random string, uniquely generated by the client. (Omit in PLAINTEXT Signature method)
  • oauth_timestamp
  • MUST be a positive integer and is expressed in the number of seconds since January 1, 1970 00:00:00 GMT. (Omit in PLAINTEXT Signature method)
  • oauth_Token
  • The token value used to associate the request with the resource owner.
  • oauth_verifier
  • The token verifier value used to associate the request with the resource owner.
  • oauth_signature_method
  • The name of the signature method used by the client to sign the request. (HMAC-SHA1/PLAINTEXT)
  • oauth_signature
  • The client calculates and assigns the value of the "oauth_signature" parameter as described in Section 3.4 of RFC5849 specification.
  • oauth_version
  • OPTIONAL. If present, MUST be set to "1.0".

Example Request

Request URL:
POST https://www.zapevent.com/api/oauth/AccessToken

Request POST Body:
N/A

Authorization Header:
OAuth oauth_nonce="792966942", oauth_token=b51d543ead3b43d69fae0ab35101eea6, oauth_signature_method="HMAC-SHA1", oauth_timestamp="1300228849", oauth_consumer_key="8493b95910d748c99bf74e61ef12043f", oauth_verifier="76bb1c1c95464e5cbd2af1c0617467c3", oauth_signature="Pc%2BMLdv028fxCErFyi8KXFM%2BddU%3D", oauth_version="1.0"

Response:
oauth_token=230bcf6370844029b72e5b67a40e772d&oauth_token_secret=277AA9779A21600B6BD391AD4AFA7B7EEF2A0BD2

API Access

All API calls require oauth authorization parameters in authorization header. Also be sure to include "https" in front of all API calls to keep your credentials secure.

Datatypes

All fields will have an associated datatype. Below are the field types used in the API.
  •   Data Type
  •   Description
  •   Valid Values
  • string
  • Character string.
  •  
  • int
  • Signed integer.
  •  
  • uint
  • Unsigned integer.
  •  
  • bool
  • Boolean value.
  •  T, F
  • format
  • Data return format.
  • xml, json, csv
  • date
  • Date formatted as "MM-DD-YYYY"
  • state
  • State or province abbreviation.
  •  
  • country
  • Country name or part of country name as string.
  •  
  • event_type
  • Event type:
    ATP-CTP, Baseball/Softball, Basketball, Business Development, Camp, Canoe/Kayak, Career Development, Clinic, Conference, Cycling/Mountain Biking, Education Program, Farm Share / CSA, Fishing, Fitness/Tai Chi/Yoga, Football, Fundraiser/Donation, Golf, Inline/Roller Skating, Lacrosse, Membership , Multi-Sport, Obstacle/Mud Run, Orienteering, Paddleboard, Retreat, Reunion, Running/Walking, Sailing, Seminar, Soccer, Special Event, Swimming, Tennis, Trade Show, Volunteer, Winter Sports/Skiing, Workshop, Youth,
  • ATP-CTP, Baseball/Softball, Basketball, Business Development, Camp, Canoe/Kayak, Career Development, Clinic, Conference, Cycling/Mountain Biking, Education Program, Farm Share / CSA, Fishing, Fitness/Tai Chi/Yoga, Football, Fundraiser/Donation, Golf, Inline/Roller Skating, Lacrosse, Membership , Multi-Sport, Obstacle/Mud Run, Orienteering, Paddleboard, Retreat, Reunion, Running/Walking, Sailing, Seminar, Soccer, Special Event, Swimming, Tennis, Trade Show, Volunteer, Winter Sports/Skiing, Workshop, Youth,

Errors

If there is an issue with your request, you may get responses such as below.
 
        <error>
          <error_code>6</error_code>
          <error_msg>Key authentication failed</error_msg>
        </error>
        <error>
          <error_code>3</error_code>
          <error_msg>Invalid parameters</error_msg>
          <param_missing>
            <param_name>api_key</param_name>
          </param_missing>
          <param_missing>
            <param_name>api_secret</param_name>
          </param_missing>
        </error>

Sample Code for Oauth 1.0 Authorization and Authentication

Sample code with dot net for OAuth Authorization and Authentication Method can be downloaded from here.

Sample Code for Login Method

Sample code with dot net for Login Method can be downloaded from here.

API Methods

API Methods are used to login to the api (using Login Method) and access the information about events, their activities and participants. These can be categorizes into three groups, one is for login, second one contains the methods for event information and third one for event participants. These are listed below:

Methods for Login

  •   Method
  •   Description
  • Login to API
  • Login to API using account credentials.

Login to API

Login the API using account credentials. This will return tmp_key and tmp_secret, that will use to get the information by other API methods.
URL
https://www.zapevent.com/api/rest/login
HTTP Method
POST
Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • format
  • GET
  • xml
  • Format of response.
  • format
  • email
  • POST
  •  
  • Account username/email.
  • string
  • password
  • POST
  •  
  • Account password.
  • string


Methods for Event Information

  •   Method
  •   Description
  • Get Event
  • Information about a specific event.
  • Get Events
  • List of upcoming events.

Get Event

Gets information about a specific event, including the event name, dates, URL, location, and activities. The output contains all activities, including past activities. To get just future activities, use the "future_activities_only" parameter and set it to T.
URL for OAuth 1.0
https://www.zapevent.com/api/event/getevent
URL for OAuth 2.0
https://www.zapevent.com/api/event/getnewevent
HTTP Method
Get
Standard Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • format
  • GET
  • xml
  • Format of response.
  • format
  • tmp_key
  • GET
  •  
  • Temporary API key from login API call.
  • string
  • tmp_secret
  • GET
  •  
  • Temporary API secret from login API call.
  • string
Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • event_id (required)
  • GET
  •  
  • ID of event.
  • uint
  • future_activities_only
  • GET
  •   F
  • Only outputs activities that occur in the future.
  • bool


Get Events

Gets a list of events, with information similar to Get event, except that only the most current activities are listed. The events can be separated into pages by using "page" and "results_per_page" parameter. The "results_per_page" parameter only contains integer value 0-250.
URL for OAuth 1.0
https://www.zapevent.com/api/event/getevents
URL for OAuth 2.0
https://www.zapevent.com/api/event/getnewevents
HTTP Method
Get
Standard Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • format
  • GET
  • xml
  • Format of response.
  • format
  • tmp_key
  • GET
  •  
  • Temporary API key from login API call.
  • string
  • tmp_secret
  • GET
  •  
  • Temporary API secret from login API call.
  • string
Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • activities
  • GET
  • T
  • Includes event activities in the output.
  • bool
  • page
  • GET
  • 1
  • Page number to get.
  • uint
  • results_per_page
  • GET
  • 10
  • Number to results per page.
  • uint
  • sort
  • GET
  • name ASC
  • Sort by "name" , "eventtype" or "date" in ascending ("ASC") or descending ("DESC") order.
  • string
Search Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • name
  • GET
  •  
  • Search by event name.
  • string
  • start_date
  • GET
  •  
  • Current Date Searches for events that occur on or after a given date.
  • date
  • end_date
  • GET
  •  
  • Searches for events that occur on or before a given date.
  • date
  • created_since
  • GET
  •  
  • Searches for events that were created on or after a given date.
  • date
  • created_on_or_before
  • GET
  •  
  • Searches for events that were created on or before a given date.
  • date
  • state
  • GET
  •  
  • Searches by state.
  • state
  • country
  • GET
  •  
  • Searches by country.
  • country
  • event_type
  • GET
  •  
  • Get events by event type.
  • event_type
  • event_status
  • GET
  • All
  • Get events by event status.
    Options {all, public, private}.
  • string


Get Categories

Gets a list of Event Categories. The Categories can be separated into pages by using "page" and "results_per_page" parameter. The "results_per_page" parameter only contains integer value 0-250.
URL for OAuth 1.0
https://www.zapevent.com/api/event/getcategories
URL for OAuth 2.0
https://www.zapevent.com/api/event/getnewcategories
HTTP Method
Get
Standard Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • format
  • GET
  • xml
  • Format of response.
  • format
  • tmp_key
  • GET
  •  
  • Temporary API key from login API call.
  • string
  • tmp_secret
  • GET
  •  
  • Temporary API secret from login API call.
  • string
Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • page
  • GET
  • 1
  • Page number to get.
  • uint
  • results_per_page
  • GET
  • 10
  • Number to results per page.
  • uint
  • sort
  • GET
  • category ASC
  • Sort by "category" in ascending ("ASC") or descending ("DESC") order.
  • string
  • future_event_categories
  • GET
  • false
  • Set true to returns the categories that have at-least 1 future event.
  • string


Get Questions

Gets a list of Event Questions based on event_id or activity_id or question_id. The Questions can be separated into pages by using "page" and "results_per_page" parameter. The "results_per_page" parameter only contains integer value 0-250.

URL for OAuth 1.0
https://www.zapevent.com/api/event/getquestions
URL for OAuth 2.0
https://www.zapevent.com/api/event/getnewquestions
HTTP Method
Get
Standard Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • format
  • GET
  • xml
  • Format of response.
  • format

Method for Event Questions Information

  •     Method
  •     Description
  •  Get Questions
  •  
  • tmp_key
  • GET
  •  
  • Temporary API key from login API call.
  • string
  • tmp_secret
  • GET
  •  
  • Temporary API secret from login API call.
  • string
Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • event_id
  • GET
  •   
  • ID of event.
  • int
  • activity_id
  • GET
  •   
  • ID of activity.
  • int
  • question_id
  • GET
  •   
  • ID of activity question.
  • int
  • page
  • GET
  • 1
  • Page number to get.
  • uint
  • results_per_page
  • GET
  • 10
  • Number to results per page.
  • uint


Get Activity Participants

Gets participants for a specific activity in an event, including the user information, registration date, and payment information.
URL for OAuth 1.0
https://www.zapevent.com/api/event/getparticipants
URL for OAuth 2.0
https://www.zapevent.com/api/event/getnewparticipants
HTTP Method
Get
Standard Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • format
  • GET
  • xml
  • Format of response.
  • format
  • tmp_key
  • GET
  •  
  • Temporary API key from login API call.
  • string
  • tmp_secret
  • GET
  •  
  • Temporary API secret from login API call.
  • string
Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • event_id (required)
  • GET
  •  
  • ID of event.
  • uint
  • activity_id
  • GET
  •  
  • ID of activity.
  • uint
  • page
  • GET
  • 1
  • Page number to get.
  • uint
  • results_per_page
  • GET
  • 10
  • Number of results per page.
  • uint
  • sort
  • GET
  • registration_id ASC
  • Sort by "registration_id", "registration_date", "age", "first_name", "last_name", "gender","participant_id" in ascending ("ASC") or descending ("DESC") order.
  • string
  • after_registration_id
  • GET
  •  
  • Get registrations after the given registration id.
  • int
  • after_participant_id
  • GET
  •  
  • Get registrations after the given participant id.
  • int
Search Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • search_first_name
  • GET
  •  
  • Search for users by first name.
  • string
  • search_last_name
  • GET
  •  
  • Search for users by last name.
  • string
  • search_email
  • GET
  • 1
  • Search for users by email address.
  • string


API Methods

API Methods are used to login to the api (using Login Method) and access the information about events, their activities and participants. These can be categorizes into three groups, one is for login, second one contains the methods for event information and third one for event participants. These are listed below:

Methods for Login

  •   Method
  •   Description
  • Login to API
  • Login to API using account credentials.

Login to API

Login the API using account credentials. This will return tmp_key and tmp_secret, that will use to get the information by other API methods.
URL
https://www.zapevent.com/api/rest/login
HTTP Method
POST
Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • format
  • GET
  • xml
  • Format of response.
  • format
  • email
  • POST
  •  
  • Account username/email.
  • string
  • password
  • POST
  •  
  • Account password.
  • string


Methods for Event Information

  •   Method
  •   Description
  • Get Event
  • Information about a specific event.
  • Get Events
  • List of upcoming events.

Get Event

Gets information about a specific event, including the event name, dates, URL, location, and activities. The output contains all activities, including past activities. To get just future activities, use the "future_activities_only" parameter and set it to T.
URL for OAuth 1.0
https://www.zapevent.com/api/event/getnewevent
HTTP Method
Get
Standard Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • format
  • GET
  • json
  • Format of response.
  • format
  • tmp_key
  • GET
  •  
  • Temporary API key from login API call.
  • string
  • tmp_secret
  • GET
  •  
  • Temporary API secret from login API call.
  • string
Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • event_id (required)
  • GET
  •  
  • ID of event.
  • uint
  • future_activities_only
  • GET
  •   F
  • Only outputs activities that occur in the future.
  • bool


Get Events

Gets a list of events, with information similar to Get event, except that only the most current activities are listed. The events can be separated into pages by using "page" and "results_per_page" parameter. The "results_per_page" parameter only contains integer value 0-250.
URL
https://www.zapevent.com/api/event/getnewevents
HTTP Method
Get
Standard Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • format
  • GET
  • json
  • Format of response.
  • format
  • tmp_key
  • GET
  •  
  • Temporary API key from login API call.
  • string
  • tmp_secret
  • GET
  •  
  • Temporary API secret from login API call.
  • string
Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • activities
  • GET
  • F
  • Includes event activities in the output.
  • bool
  • page
  • GET
  • 1
  • Page number to get.
  • uint
  • results_per_page
  • GET
  • 10
  • Number to results per page.
  • uint
  • sort
  • GET
  • name ASC
  • Sort by "name" , "eventtype" or "date" in ascending ("ASC") or descending ("DESC") order.
  • string
Search Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • name
  • GET
  •  
  • Search by event name.
  • string
  • start_date
  • GET
  • today
  • Current Date Searches for events that occur on or after a given date.
  • date
  • end_date
  • GET
  •  
  • Searches for events that occur on or before a given date.
  • date
  • created_since
  • GET
  •  
  • Searches for events that were created on or after a given date.
  • date
  • created_on_or_before
  • GET
  •  
  • Searches for events that were created on or before a given date.
  • date
  • state
  • GET
  •  
  • Searches by state.
  • state
  • country
  • GET
  •  
  • Searches by country.
  • country
  • event_type
  • GET
  •  
  • Get events by event type.
  • event_type


Get Categories

Gets a list of Event Categories. The Categories can be separated into pages by using "page" and "results_per_page" parameter. The "results_per_page" parameter only contains integer value 0-250.
URL
https://www.zapevent.com/api/event/getnewcategories
HTTP Method
Get
Standard Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • format
  • GET
  • json
  • Format of response.
  • format
  • tmp_key
  • GET
  •  
  • Temporary API key from login API call.
  • string
  • tmp_secret
  • GET
  •  
  • Temporary API secret from login API call.
  • string
Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • page
  • GET
  • 1
  • Page number to get.
  • uint
  • results_per_page
  • GET
  • 10
  • Number to results per page.
  • uint
  • sort
  • GET
  • category ASC
  • Sort by "category" in ascending ("ASC") or descending ("DESC") order.
  • string
  • future_event_categories
  • GET
  • false
  • Set true to returns the categories that have at-least 1 future event.
  • string


Get Questions

Gets a list of Event Questions based on event_id or activity_id or question_id. The Questions can be separated into pages by using "page" and "results_per_page" parameter. The "results_per_page" parameter only contains integer value 0-250.

URL
https://www.zapevent.com/api/event/getnewquestion
HTTP Method
Get
Standard Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • format
  • GET
  • json
  • Format of response.
  • format

Method for Event Questions Information

  •     Method
  •     Description
  •  Get Questions
  •  
  • tmp_key
  • GET
  •  
  • Temporary API key from login API call.
  • string
  • tmp_secret
  • GET
  •  
  • Temporary API secret from login API call.
  • string
Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • event_id
  • GET
  •   
  • ID of event.
  • int
  • activity_id
  • GET
  •   
  • ID of activity.
  • int
  • question_id
  • GET
  •   
  • ID of activity question.
  • int
  • page
  • GET
  • 1
  • Page number to get.
  • uint
  • results_per_page
  • GET
  • 10
  • Number to results per page.
  • uint


Get Activity Participants

Gets participants for a specific activity in an event, including the user information, registration date, and payment information.
URL
https://www.zapevent.com/api/event/getnewparticipants
HTTP Method
Get
Standard Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • format
  • GET
  • json
  • Format of response.
  • format
  • tmp_key
  • GET
  •  
  • Temporary API key from login API call.
  • string
  • tmp_secret
  • GET
  •  
  • Temporary API secret from login API call.
  • string
Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • event_id (required)
  • GET
  •  
  • ID of event.
  • uint
  • activity_id
  • GET
  •  
  • ID of activity.
  • uint
  • page
  • GET
  • 1
  • Page number to get.
  • uint
  • results_per_page
  • GET
  • 10
  • Number of results per page.
  • uint
  • sort
  • GET
  • registration_id ASC
  • Sort by "registration_id", "registration_date", "age", "first_name", "last_name", "gender" in ascending ("ASC") or descending ("DESC") order.
  • string
  • after_registration_id
  • GET
  •  
  • Get registrations after the given registration id.
  • int
Search Parameters
  •   Parameter
  •   Http Method
  •   Default
  •   Description
  •   Datatype
  • search_first_name
  • GET
  •  
  • Search for users by first name.
  • string
  • search_last_name
  • GET
  •  
  • Search for users by last name.
  • string
  • search_email
  • GET
  • 1
  • Search for users by email address.
  • string


Error Codes

  •   Code
  •   Message
  • 3
  • Invalid Parameters.
  • 6
  • Key Authentication Failed.
  • 7
  • Permission Denied.
  • 10
  • Response format not supported for this REST method.
  • 12
  • Request recieved out of order.
  • 101
  • User Not Found.
  • 102
  • Password Invalid.
  • 201
  • Event Not Found.
  • 301
  • Activity Not Found.

ZapEvent OAuth 2 API Documentation

ZapEvent API can be accessed by using one of the following methods:
  • - Login Method
  • - OAuth Authorization and Authentication Method

Login Method

Login method allows the consumer to provide the ZapEvent Login credentials (username and password) for accessing the ZapEvent OAuth 2 API. This will return the temporary key and temporary secret and shall use in API Calls to access the data.

OAuth 2 Authorization and Authentication Method

Step 1- POST Authorization

Allows a Consumer application to obtain an OAuth 2.0 Authorization code to request user authorization. In this step user send the request with Client id and Client Secret and Redirect URL. If credentials are valid it returns the Authorization code. This method fulfills Section 6.1 of the OAuth 2.0 authentication flow.

It is strongly recommended you use HTTPS for all OAuth 2.0 authorization steps.
Resource URL
https://www.zapevent.com/api/oauth2/Authorize
Parameters
OAuth 2.0 parameters are always sent the same way as other parameters. If you're using HTTP-header based OAuth 2.0, you shouldn't include oauth_* parameters in the POST body or querystring.
  •   Parameter Name
  •   Value Description
  • oauth_consumer_key
  • The identifier portion of the client credentials provided by the server.
  • oauth_callback
  • URL (query parametrs)/encoded URI (Authorization Header) back to which the server will redirect the resource owner when the Resource Owner Authorization step is completed.
  • responce_type
  • The value MUST be one of "code" for requesting an authorization code as described by Section 4.1.1, "token" for requesting an access token (implicit grant) as described by Section 4.2.1, or a registered extension value as described by Section 8.4.

Example Request

Request URL:
POST https://www.zapevent.com/api/oauth2/Authorization

Request POST Body:
N/A

Authorization Header:
Connection = keep-alive Accept = text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8 Accept-Encoding = gzip, deflate, sdch Accept-Language = en-US,en;q=0.8 Host = clouddev.crm.powerobjects.net Referer = https://zapier.com/app/editor/3574662 User-Agent = Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.118 Safari/537.36
Response:
Authorization Code

Step 2- Access Token Request

The client makes a request for the access token to get the resource of the users.
Please use HTTPS for this method, and all other OAuth token negotiation steps.


Resource URL
https://www.zapevent.com/api/OAuth2/RequestToken
Parameters
OAuth parameters are always sent the same way as other parameters. If you're using HTTP-header based OAuth, you shouldn't include oauth_* parameters in the POST body or querystring.
  •   Parameter Name
  •   Value Description
  • grant_type
  • REQUIRED. Value MUST be set to "authorization_code
  • code
  • REQUIRED. The authorization code received from the authorization server.
  • redirect_uri
  • REQUIRED, if the "redirect_uri" parameter was included in the authorization request as described in Section 4.1.1, and their values MUST be identical.
  • client_id
  • REQUIRED, if the client is not authenticating with the authorization server as described in Section 3.2.1.

Example Request

Send the user to the oauth/authorize step in a web browser, including an oauth_token parameter:
https://www.zapevent.com/api/oauth/RequestToken?grant_type=authorization_code&code=SplxlOBeZQQYbYS6WxSbIA&redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb

Request POST Body:
N/A

Authorization Header:
N/A

Response:
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Cache-Control: no-store Pragma: no-cache { "access_token":"2YotnFZFEjr1zCsicMWpAA", "token_type":"example", "expires_in":3600, "refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA", "example_parameter":"example_value" }

API Access

All API calls require oauth authorization parameters in authorization header. Also be sure to include "https" in front of all API calls to keep your credentials secure.

Datatypes

All fields will have an associated datatype. Below are the field types used in the API.
  •   Data Type
  •   Description
  •   Valid Values
  • string
  • Character string.
  •  
  • int
  • Signed integer.
  •  
  • uint
  • Unsigned integer.
  •  
  • bool
  • Boolean value.
  •  T, F
  • format
  • Data return format.
  • xml, json, csv
  • date
  • Date formatted as "MM-DD-YYYY"
  • state
  • State or province abbreviation.
  •  
  • country
  • Country name or part of country name as string.
  •  
  • event_type
  • Event type:
    ATP-CTP, Baseball/Softball, Basketball, Business Development, Camp, Canoe/Kayak, Career Development, Clinic, Conference, Cycling/Mountain Biking, Education Program, Farm Share / CSA, Fishing, Fitness/Tai Chi/Yoga, Football, Fundraiser/Donation, Golf, Inline/Roller Skating, Lacrosse, Membership , Multi-Sport, Obstacle/Mud Run, Orienteering, Paddleboard, Retreat, Reunion, Running/Walking, Sailing, Seminar, Soccer, Special Event, Swimming, Tennis, Trade Show, Volunteer, Winter Sports/Skiing, Workshop, Youth,
  • ATP-CTP, Baseball/Softball, Basketball, Business Development, Camp, Canoe/Kayak, Career Development, Clinic, Conference, Cycling/Mountain Biking, Education Program, Farm Share / CSA, Fishing, Fitness/Tai Chi/Yoga, Football, Fundraiser/Donation, Golf, Inline/Roller Skating, Lacrosse, Membership , Multi-Sport, Obstacle/Mud Run, Orienteering, Paddleboard, Retreat, Reunion, Running/Walking, Sailing, Seminar, Soccer, Special Event, Swimming, Tennis, Trade Show, Volunteer, Winter Sports/Skiing, Workshop, Youth,

Errors

If there is an issue with your request, you may get responses such as below.
 
        <error>
          <error_code>6</error_code>
          <error_msg>Key authentication failed</error_msg>
        </error>
        <error>
          <error_code>3</error_code>
          <error_msg>Invalid parameters</error_msg>
          <param_missing>
            <param_name>api_key</param_name>
          </param_missing>
          <param_missing>
            <param_name>api_secret</param_name>
          </param_missing>
        </error>

Sample Code for Oauth 1.0 Authorization and Authentication

Sample code with dot net for OAuth Authorization and Authentication Method can be downloaded from here.

Sample Code for Login Method

Sample code with dot net for Login Method can be downloaded from here.
×
×
×
×