| Why do I need to register to gain access to your APIs? |
ACTIVE Network has chosen Mashery to make our APIs publicly available to interested developers. Mashery provides API key and issue management for all ACTIVE APIs. The registration process gives you test access, which you can use during the development of your application or site. |
| What is an API key? |
An API key is a code that provides you with access to an API. API keys are used to track how the API is being used in order to prevent malicious use or abuse of the terms of service. |
| What is an API and how do I use it? |
The ACTIVE APIs are used to get information about events and activities stored within our database. They allow developers to build web-based applications to display the information however they like, as seen in the API Gallery. We only require that they follow our brand guidelines.
The 'Documentation' tab above will give you all the details about the methods, parameters, and details about each API. If you are unfamiliar with using APIs to dynamically display information, I would suggest using our widgets to display information on your website. You can view and customize our widgets here: http://widgets.ACTIVE.com/.
If you'd like to earn commissions on events that are registered through your website, then you can sign up to become and affiliate and then create your widget. Sign up here: http://www.ACTIVEnetwork.com/affiliates.htm
|
| Does having an API key mean I can make live registrations through your APIs? |
No, the API key provides 'Read-Only' access to our database of events and activities. |
| How do I implement my Key? |
An example of how to insert your key into the HTTP request - http://api.amp.ACTIVE.com/search?{queryString params}&api_key={xxxYourAPIkeyxxx} |
| What are the rate limits set on my keys? |
The default rate limits set on your keys are documented within each section of the API documentation as well as within My Account > Keys |
| How do I get new keys? |
Keys are grouped together within an Application. If you need additional keys – for example, if you're building a new site – simply create a new Application from within My Account > Applications. When you create the new Application, you'll be able to select the new keys you need. You may only have one Search API key per Application. |
| How do I delete keys? What is the impact if I delete a key? |
From within My Account > Keys you can delete any key. Deleting your key disables access to the API to which the key relates. For example, if you delete a key that only had test access, you'll no longer be able to make queries to the API. If you wish to go live again after deleting a key and receiving a new one, embed the new key in your application or site before you go live. |
| What is an Application? How do keys relate to Applications? |
An Application is the container for each individual API key, and is also the basis upon which you request to Go Live. An API key is to an Application as a license plate is to a car. |
| How do I get a new Application? Why would I want one? |
You can get a new Application by clicking "Create a New Application" within My Account > Applications. A new Application may be appropriate for a redesigned site or a spin-off business. Perhaps you'd like multiple Search API keys for a set of location-targeted sites, in which case you'd need an Application for each key, since only one key can be included in an Application. |
| What reports can I access? |
Within the My Account > Keys section, you'll have access to near-real-time information about your current period rate limit and when the rate limit period resets. Current reports include selectable periods of time (today, last 7 days, this month, last month) and charts which will display total calls, top calls by method, and errors received. Each of these reports can also be exported to a CSV for offline consumption. |
| What do I need to start developing and making test calls against the ACTIVE API? |
A good to place to start is our I/O Docs found here: http://developer.ACTIVE.com/io-docs. Interact with the ACTIVE APIs - discover, test, debug live calls all in one place. If you like what you see, register for an account and start developing! |
| What kind of data can I get from the API? |
To explore the kind of data available to you in the API, check the documentation for each API. |
| How do I know that my request (query) is working? |
Queries can be verified by simply passing your requests to the URLs provided to you through the Documentation Center and receiving a successful result. |
| Where are the stats for Affiliate API partners? |
Affiliate stats are found in the Affiliate Center by logging into your account here: http://www.ACTIVEnetwork.com/affiliates.htm
Note that any sales made today will appear in your account stats tomorrow. |
| Common Development and Programming Questions |
|
| Troubleshooting Steps |
Troubleshooting with the API is usually done with these steps:
Examine the HTTP response closely: the status code you received back, the message that accompanies that code, the HTTP headers in the response, and the response body itself -- the response body usually contains the most specific information about the nature of an error.
If the response body doesn't help identify the problem, check @ACTIVEapi to see if there are any known issues with the API at that time.
If you are still seeing problems, post a message on the forum where ACTIVE Network Employees and Community Developers can try and help you. Make sure you include the language you are using, the request that's failing and the response message (including headers) that you get back. The more information you provide the quicker somebody can help you out. |
| Where Do I Begin? |
We are constantly working to developing deep, accurate technical documentation. The best place to start is by studying the documentation. We have complete examples of multiple protocols for easy study. Become familiar with all the content on each request/response outline you're working with and follow up with the additional Resources and Assets available. |
| Why does my search result have a different list of events and activities than ACTIVE.com? |
ACTIVE.com, ACTIVEGolf.com, ReserveAmerica.com operate separately. Individual results will vary or lack data between the sites, including price discrepancies, lack of ratings, etc. ACTIVE.com, ACTIVEGolf.com, ReserveAmerica.com should never be compared in method of operation, display, or results as an expectation of the API's performance. They all have implemented a completely different set of business requirements have a different default platform behavior.
If you use various parameters in searching, it will alter or narrow your own list. If you use any other sorting than the default order of the list, your result will vary. The list returned is based on those parameters submitted. The basic search parameters are recommended to return the best initial list for your visitor to peruse and then change based on his preferences. The more filters or search parameters are added to the request, the fewer properties may be returned.
Regarding ACTIVE.com:
ACTIVE.com uses a completely different program and algorithm to access assets from their own database, and therefore we will not always see the exact same result as on their site. In addition, there are assets which are not available to any outside sources and will not be seen in your results. You cannot expect to perfectly match all results to ACTIVE result pages. Any descrepancies in data or content simply means the updates/changes haven't yet reached our data cache.
|
| What do the errors mean? |
Refer to the Error Handling section for details on exceptions and error handling. |
| What info is required on my site? |
See the Launch Requirements for all required items on your site. Use this resource while in development so that all check points are covered during your programming efforts. This will save you from reworking code later if your site fails the approval process. |
| What is the approval to go live? |
Once you have completed your API implementation, please contact support-affiliate@activenetwork.com and let us know you are ready to go live! We will verify that your API implementation follow the brand guidelines and includes proper brand attribution.
We cannot certify your code since we have no way to know exactly how you are processing your requests, writing your scripts, or the accuracy of your application or programming. You are still responsible for correcting any bugs that may later be revealed when errors in code create tracking issues, per your affiliate contract.
Test bookings may reveal errors in your reservation request structure, but not the entirety of your live code. A launch approval is not a guarantee your site is completely free of any bugs or customer experience issues.
Affiliates must read the documenation in order to become familiar with the details of the outline elements and any inherent behaviour of the system.
|
