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

REST API ApiKey

From XING Events Developer Documentation
Jump to: navigation, search

Object type: apiKey

Properties

API key objects provide the following properties.

Attributes: R - accessible in read requests W - accessible in write (update) requests C - accessible in create requests

Property Type Attributes Description
id Integer R-- The internal database id of this object.
key String R-- The API key access information.
identifier String R-- The identifier of this API key.
name
String R-C The name of the API key. required
enabled String RW- Whether this API key is enabled or not.


Methods

Additional to the standard methods described in API Overview the API key interface provides following methods.


Create

Call POST /api/apiKey/create
Parameters Required is name.
Description This request will create an API key and will return the internal id and the API key information. The internal id can be used for update requests. The API key can be used to request permissions for users or events or to create a Partner. See Request Permission, Grant Permission or Create Partner
Response {"id":<internal id>,"success":true,"apiKey":{"key":...}}.
Errors See General Errorcodes.

Update

Call POST /api/apiKey/<id>
Parameters All properties marked with W.
Description This request will update the properties of the API key with the internal id <id>. Only properties which are provided as parameters will be updated.
Response {"success":true}.
Errors com.amiando.Partner.NotAuthorized

See General Errorcodes.

REST API Contents
Getting Started Get your API key Overview Formats Errors
Data Types Event Participant Payment Ticket
Ticket Categories ProductDefinition Products CodeDefinition
TicketShop Addresses Ticket Types Payment Types
BankAccount UserDataDefinition UserData User
Partner ApiKey
Data Synchronization Sync Interface