Due to PCI compliant reasons we're going to turn off support for TLS v1.0 on all of our servers.
Please check/update you API implementations to support TLS v1.2 until 29.06.2018

Difference between revisions of "Documentation"

From XING Events Developer Documentation
Jump to: navigation, search
(New page: The Documentation Page ....)
 
Line 1: Line 1:
The Documentation Page ....
+
amiando provides you with a variety of APIs ranging from easy-to-use widgets to the full blown Event Management API. Use the overview below to find the right API technology for your project or take a look at our App Showcase to see what others have done with our API.<br/>
 +
'''Available API technologies'''
 +
=HTML Widgets for event hosts=
 +
When you are hosting your events with amiando nothing is easier than integrating them into your own website. In your amiando account you can easily access HTML code to copy/paste into your website or CMS with a few clicks and without a single line of code.
 +
The most requested widgets are:
 +
*online event registration forms
 +
*ticket shops with payment
 +
*a list of all events you are currently organizing
 +
*a list of event participants.
 +
Read the documentation on Widgets
 +
=amiando Event Management API=
 +
This is the main API. The API is based on a RESTful JSON interface. Use this API to create amiando objects (e.g. users and events) and to get information about events (e.g. participant list for events).
 +
Typical use cases are:
 +
*Retrieve event participants to synchronize with a CRM
 +
*Retrieve ticket payments to synchronize with ERP and e-commerce tracking
 +
*Create users and events to automate workflows
 +
Read the documentation on amiando Event Management API
 +
=EventSense API=
 +
Use this API to get information about public events listed on amiando.
 +
Typical use case:
 +
*Get public event content for event directory or mobile application
 +
Read the documentation on EventSense API
 +
=Tracking Webhooks=
 +
A Webhook is a script on your server that will be called with all relevant information whenever an event is caused on the amiando server. 
 +
Typical use case: 
 +
*Integrate amiando with your e-commerce tracking / analytics tool
 +
Read the documentation on Tracking Webhooks
 +
=CommunityTicketing API=
 +
This Javascript API lets you add a ticketing feature on top of an existing event feature. There is an option to receive a revenue share on ticketing revenues that are generated through your events.
 +
Typical use case:
 +
*Add ticketing to the event feature of your community
 +
Take a look at the Community Ticketing API.
 +
=XML-RPC API (Legacy)=
 +
Most features of this API are available in a more convenient way from the amiando Event Management API. However if you want to implement entry management functionality, you will have to use this API.
 +
Typical use case:
 +
*Mobile application to validate tickets at an event Take a look at the XML-RPC API (Legacy).

Revision as of 13:55, 17 November 2010

amiando provides you with a variety of APIs ranging from easy-to-use widgets to the full blown Event Management API. Use the overview below to find the right API technology for your project or take a look at our App Showcase to see what others have done with our API.
Available API technologies

HTML Widgets for event hosts

When you are hosting your events with amiando nothing is easier than integrating them into your own website. In your amiando account you can easily access HTML code to copy/paste into your website or CMS with a few clicks and without a single line of code. The most requested widgets are:

  • online event registration forms
  • ticket shops with payment
  • a list of all events you are currently organizing
  • a list of event participants.

Read the documentation on Widgets

amiando Event Management API

This is the main API. The API is based on a RESTful JSON interface. Use this API to create amiando objects (e.g. users and events) and to get information about events (e.g. participant list for events). Typical use cases are:

  • Retrieve event participants to synchronize with a CRM
  • Retrieve ticket payments to synchronize with ERP and e-commerce tracking
  • Create users and events to automate workflows

Read the documentation on amiando Event Management API

EventSense API

Use this API to get information about public events listed on amiando. Typical use case:

  • Get public event content for event directory or mobile application

Read the documentation on EventSense API

Tracking Webhooks

A Webhook is a script on your server that will be called with all relevant information whenever an event is caused on the amiando server. Typical use case:

  • Integrate amiando with your e-commerce tracking / analytics tool

Read the documentation on Tracking Webhooks

CommunityTicketing API

This Javascript API lets you add a ticketing feature on top of an existing event feature. There is an option to receive a revenue share on ticketing revenues that are generated through your events. Typical use case:

  • Add ticketing to the event feature of your community

Take a look at the Community Ticketing API.

XML-RPC API (Legacy)

Most features of this API are available in a more convenient way from the amiando Event Management API. However if you want to implement entry management functionality, you will have to use this API. Typical use case:

  • Mobile application to validate tickets at an event Take a look at the XML-RPC API (Legacy).