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 "XING TicketingManager REST API"

From XING Events Developer Documentation
Jump to: navigation, search
(Data types)
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
Welcome to the amiando REST API Documentation.
+
XING Events provides a [http://en.wikipedia.org/wiki/Representational_State_Transfer REST] interface to create, update and delete events, tickets,...
  
amiando provides a [http://en.wikipedia.org/wiki/Representational_State_Transfer REST] interface to create, update and delete users and events. Nearly any computer language can be used to communicate over HTTP with the REST server.
+
This documentation is aimed at developers who want to integrate the XING TicketingManager platform into their applications.
 
 
This documentation is aimed at developers who want to integrate the amiando platform into their applications.
 
  
 
==Getting started==
 
==Getting started==
 
+
Read our [[Getting_Started|Getting Started]] page to get started.
* First, you have to create an account on amiando if you do not have one yet
 
* After creating your account, you have to register your project to get access to an API key (See [[How to get your API key]] for details)
 
* Using your API key, you can start to make REST calls. See the documentation below for details. If you need help, take a look at the [[How-Tos#amiando_API_examples|How-Tos]].
 
  
 
==API Reference==
 
==API Reference==
  
 
=====General information=====
 
=====General information=====
*[[REST_API_Overview|Overview]] — Provides information to the general format of REST requests and response format.
+
*[[REST_API_Overview|Overview]]<br>Provides information to the general format of REST requests and response format.
*[[REST_API_Formats|Formating]] &mdash; How to format various property types (Date, Timezone, etc.)
+
*[[REST_API_Formats|Formating]]<br>How to format various property types (Date, Timezone, etc.)
*[[REST_API_ErrorCodes|Errorcodes]] &mdash; A list of all error codes generated by the REST API.
+
*[[REST_API_ErrorCodes|Errorcodes]]<br>A list of all error codes generated by the REST API.
*[[REST_API_DataSync|Data Synchronization]] &mdash; Documentation of the data synchronization API (Used for informing you about new objects or updates of your object)
+
*[[REST_API_DataSync_v2|Data Synchronization v2]]<br>Documentation of the data synchronization API (Used for informing you about new objects or updates of your object)
  
 
=====Data types=====
 
=====Data types=====
*[[REST_API_Events|Events]] &mdash; Properties and methods of the event objects (Creating, updating, deleting events etc).
+
*[[REST_API_Events|Events]]<br>Properties and methods of the event objects (Creating, updating, deleting events etc).
*[[REST_API_Participants|Participants]] &mdash; The participant object provides access to read or update every single attendee of an event.
+
*[[REST_API_Participants|Participants]]<br>The participant object provides access to read or update every single attendee of an event.
*[[REST_API_Payments|Payments]] &mdash; A payment represents one purchase/registration in the event's ticket shop/registration form (Creating, updating, reading payments).
+
*[[REST_API_Payments|Payments]]<br> A payment represents one purchase/registration in the event's ticket shop/registration form (Creating, updating, reading payments).
*[[REST_API_Tickets|Tickets]] &mdash; During one purchase/registration the buyer may buy one or multiple tickets (Reading of ticket details).
+
*[[REST_API_Tickets|Tickets]]<br>During one purchase/registration the buyer may buy one or multiple tickets (Reading of ticket details).
*[[REST_API_TicketCategories|Ticket Categories]] &mdash; Properties and methods of the selected/available ticket categories objects.
+
*[[REST_API_TicketCategories|Ticket Categories]]<br>Properties and methods of the selected/available ticket categories objects.
*[[REST_API_Products|Products]] &mdash; Additional products may be available during the buying/registration process (Updating and reading availbale/selected products).
+
*[[REST_API_ProductDefinition|ProductDefiniton]]<br>Additional products may be available during the buying/registration process, this objects represent what products are available and what options they provide.
*[[REST_API_TicketShops|TicketShop]] &mdash; The TicketShop object offers properties and methods for updating and reading details of the shop system of your event.
+
*[[REST_API_Products|Products]]<br>This object represents a product that was bought by participant.
*[[REST_API_Addresses|Addresses]] &mdash; The address object is used in multiple cases to read or update a specific address (billing address, shipment address or other address requested in the ticket shop).
+
*[[REST_API_CodeDefinition|CodeDefinition]]<br>With this object you can manage the promotion codes of your event.
*[[REST_API_TicketTypes|Ticket Types]] &mdash; Nested object to update and read the available types of tickets in the shop (e.g. E-Ticket, Paper-Ticket, ...)
+
*[[REST_API_TicketShops|TicketShop]]<br>The Ticketshop object offers properties and methods for updating and reading details of the shop system of your event.
*[[REST_API_PaymentTypes|Payment Types]] &mdash; Nested object to update and read the available payment types in the shop (e.g. Credit card, PayPal, ...)
+
*[[REST_API_Addresses|Addresses]]<br>The address object is used in multiple cases to read or update a specific address (billing address, shipment address or other address requested in the ticket shop).
*[[REST_API_BankAccounts|BankAccount]] &mdash;  Nested object to update and read the bank account information of a user
+
*[[REST_API_TicketTypes|Ticket Types]]<br>Nested object to update and read the available types of tickets in the shop (e.g. E-Ticket, Paper-Ticket, ...)
*[[REST_API_UserData|UserData]] &mdash;  Nested object to read additional information of a ticket buyer requested by the organizer during the purchase process
+
*[[REST_API_PaymentTypes|Payment Types]]<br>Nested object to update and read the available payment types in the shop (e.g. Credit card, PayPal, ...)
*[[REST_API_Users|Users]] &mdash; Properties and methods of the user objects (Creating, updating, deleting users etc).
+
*[[REST_API_BankAccounts|BankAccount]]<br>Nested object to update and read the bank account information of a user
*[[REST_API_Partner|Partner]] &mdash; Properties and methods of the partner objects (Creating, updating, deleting partners etc).
+
*[[REST_API_UserData|UserData]]<br>Nested object to read additional information of a ticket buyer requested by the organizer during the purchase process
*[[REST_API_ApiKey|API Key]] &mdash; Properties and methods of the api key objects (Creating, updating API keys etc).
+
*[[REST_API_Users|Users]]<br>Properties and methods of the user objects (Creating, updating, deleting users etc).
*[[Public_Events|Public Events]] &mdash; Properties and methods that are accessible without the need of an API-Key. It provides event information of all public amiando events.
+
*[[REST_API_ApiKey|API Key]]<br>Properties and methods of the api key objects (Creating, updating API keys etc).

Revision as of 09:04, 30 January 2019

XING Events provides a REST interface to create, update and delete events, tickets,...

This documentation is aimed at developers who want to integrate the XING TicketingManager platform into their applications.

Getting started

Read our Getting Started page to get started.

API Reference

General information
  • Overview
    Provides information to the general format of REST requests and response format.
  • Formating
    How to format various property types (Date, Timezone, etc.)
  • Errorcodes
    A list of all error codes generated by the REST API.
  • Data Synchronization v2
    Documentation of the data synchronization API (Used for informing you about new objects or updates of your object)
Data types
  • Events
    Properties and methods of the event objects (Creating, updating, deleting events etc).
  • Participants
    The participant object provides access to read or update every single attendee of an event.
  • Payments
    A payment represents one purchase/registration in the event's ticket shop/registration form (Creating, updating, reading payments).
  • Tickets
    During one purchase/registration the buyer may buy one or multiple tickets (Reading of ticket details).
  • Ticket Categories
    Properties and methods of the selected/available ticket categories objects.
  • ProductDefiniton
    Additional products may be available during the buying/registration process, this objects represent what products are available and what options they provide.
  • Products
    This object represents a product that was bought by participant.
  • CodeDefinition
    With this object you can manage the promotion codes of your event.
  • TicketShop
    The Ticketshop object offers properties and methods for updating and reading details of the shop system of your event.
  • Addresses
    The address object is used in multiple cases to read or update a specific address (billing address, shipment address or other address requested in the ticket shop).
  • Ticket Types
    Nested object to update and read the available types of tickets in the shop (e.g. E-Ticket, Paper-Ticket, ...)
  • Payment Types
    Nested object to update and read the available payment types in the shop (e.g. Credit card, PayPal, ...)
  • BankAccount
    Nested object to update and read the bank account information of a user
  • UserData
    Nested object to read additional information of a ticket buyer requested by the organizer during the purchase process
  • Users
    Properties and methods of the user objects (Creating, updating, deleting users etc).
  • API Key
    Properties and methods of the api key objects (Creating, updating API keys etc).