Introduction

This documentation describes the API that can be used to access the Eventicious content management system.

The API allows to edit the event schedule, as well as to add, edit, or change sessions, locations, session tags, speakers and attendees.

In order to test running the queries presented in the documentation using Postman, you must create an account and import a collection of queries by clicking Run in Postman above and then Fork/Import Collection.

Postman provides the ability to get code in many programming languages to submit queries.

Setting variables

After copying the collection to your account, you will have the Eventicious External API collection and the Eventicious External API environment. For correct work of collection queries and code samples generation, you need to set up collection and environment variables (see Defining collection variables and Editing environment variables for details).

In collection and environment it is necessary to set client_id and client_secret parameters, more details on how to get and use it are described in the Authentication section below.

Authentication

The API Authentication uses a secret key. A key is a pair of values client_id and client_secret. To obtain the key, please contact the Event Rocks content department.

Each event is assigned its own key. The key can be used to make requests using the following Authorization header format: Authorization: Bearer {bearer_token}

Relations between objects

When making a request, make sure to specify internal IDs of the objects in your system. These IDs must also be used when defining relations between objects.

For example:

You have created a speaker with id=15. When creating a presentation with this speaker, you need to specify an array containing this id(15) in the speakersIds field.

Adding content in several languages

The Eventicious Public API also allows to add event content translated into several languages. To do that, follow these general rules:

• POST requests always create entities in the main language of the conference.

• Any PUT request can have the language field added to it, and the required locale should be passed in that field. Use en-US for the English language:

  • If this field is absent, editing will be performed in the main language.

  • If this field is present, but the passed language is not one of the event languages or is invalid, editing will be performed in the main language.

  • If this field is present and the passed locale matches one of the conference languages, editing will be performed in that language.

General information

If a request is succeeded, a response code 200 will be returned.

If the field accepts a link to the image (in particular, externalImagePath), the link must be provided as a valid URL. The server response, when accessed by URL, must contain the content-type header. For images it is supported

• content-type: image/jpeg

• content-type: image/png

Some fields, specifically, the description field in attendee profile and in event details, the privateinfo field in attendee profile, and the details field in exhibitor card, support text formatting.

The following tags are supported:

• < p >< strong >text< /strong >< /p >

• < ul >< li >marked list< /li >< /ul >

• < ol >< li >numeric list< /li >< /ol >

• < span class="textlarge">Large text< /span >

• < span class="textsmall" >Small text< /span >

• < div>Header< /div >

• < strong>bold< /strong >

• < em >italic< /em >

• < span style="text-decoration: underline">underline< /span >

• < a title="header" href="https://ya.ru/">hyperlink< /a >