API docs by Redocly

Actiup Public Endpoint API (1.0.0)

Download OpenAPI specification:Download

Our API (Application Programming Interface) provides a streamlined method for developers to integrate our services into their applications seamlessly. By leveraging our API, developers can access a wide range of functionalities, empowering them to create innovative solutions and enhance user experiences.

authenticate

APIs to obtain token; when calling Actiup's public API, token MUST be supplied to authenticate with server via header Authorization.

1. API get token

This API provides functionality for exchanging client_id + client_secret to temporary token

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Request Body schema:
required
client_id
required
string

Client id generated for each Actiup's partner, contact Actiup to get id + secret key pair

client_secret
required
string

Client secret corresponding to client_id generated for each Actiup's partner, contact Actiup to get id + secret key pair

Responses

Request samples

Content type
{
  • "client_id": "string",
  • "client_secret": "string"
}

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    },
  • "error": { }
}

event

APIs for event information.

1. API for listing event with paging

This API provides pagination functionality for accessing events content within a system. It allows users to navigate through a large set of events by retrieving specific pages of data, enhancing efficiency and manageability when dealing with extensive event datasets.

query Parameters
event_category_id
string

Filters results based on the category of the event.

event_type
string
Enum: "attractions" "sports"

Filters results based on the type of event.

limit
integer
Default: 10

Specifies the maximum number of items to return in a single response.

offset
integer
Default: 0

Indicates the starting point from which to retrieve data, useful for pagination.

selling_type
string
Enum: "selling" "sold_out" "view"

Filters results based on the selling type of the event (e.g., ticketed, free).

sort_by
string
Default: "created_at.desc"
Enum: "close_registration_date.desc" "created_at.asc" "created_at.desc" "event_date.desc" "homepage_position_number.asc" "min_price.asc" "min_price.desc" "open_registration_date.desc" "position_number.asc" "price.asc" "price.desc" "start_date.asc" "start_date.desc"

Specifies the criteria for sorting the returned results.

type
string
Default: "normal"
Enum: "homepage_normal" "normal"

Filters results for homepage position.

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    },
  • "error": { }
}

2. API get event relation

This API will provide events related to the passed event_id.

path Parameters
event_id
required
string

ID of event selected.

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    },
  • "error": { }
}

3. API for listing event by merchant

This API provides pagination functionality for accessing events content within a system. It allows users to navigate through a large set of events by retrieving specific pages of data, enhancing efficiency and manageability when dealing with extensive event datasets.

path Parameters
merchant_id
required
string

ID of the merchant.

page
required
integer

Specifies the starting point for retrieving data, particularly useful for pagination purposes.

query Parameters
limit
integer
Default: 10

Specifies the maximum number of items to return in a single response.

selling_type
string
Enum: "selling" "sold_out" "view"

Filters results based on the selling type of the event (e.g., ticketed, free).

sort_by
string
Default: "created_at.desc"
Enum: "close_registration_date.desc" "created_at.asc" "created_at.desc" "event_date.desc" "homepage_position_number.asc" "min_price.asc" "min_price.desc" "open_registration_date.desc" "position_number.asc" "price.asc" "price.desc" "start_date.asc" "start_date.desc"

Specifies the criteria for sorting the returned results.

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    },
  • "error": { }
}

4. API get event for homepage

This API will provide events information for homepage.

path Parameters
event_type
required
string
Enum: "attractions" "sports"

This type of event.

limit
required
integer

Specifies the maximum number of items to return in a single response.

type
required
string
Enum: "homepage_hot" "homepage_normal"

This type for homepage.

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": [
    ],
  • "error": { }
}

info event

APIs for detail event information.

1. API get event by id

The Event Retrieval API fetches detailed information about individual events using their unique IDs.

path Parameters
event_id
required
string

ID of the events.

query Parameters
includes
string

Lists which event fields are excluded. Example includes=club

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    },
  • "error": { }
}

2. API get event info by id

The Event Retrieval API fetches detailed information about individual events using their unique slug.

path Parameters
event_id
required
string

ID of the events.

query Parameters
includes
string

Lists which event fields are excluded. Example includes=club

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    },
  • "error": { }
}

3. API get event by slug

The Event Retrieval API fetches detailed information about individual events using their unique slug.

path Parameters
event_slug
required
string

Slug of the events.

query Parameters
includes
string

Lists which event fields are excluded. Example includes=club

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    },
  • "error": { }
}

4. API get event info by slug

The Event Retrieval API fetches detailed information about individual events using their unique slug.

path Parameters
event_slug
required
string

Slug of the events.

query Parameters
includes
string

Lists which event fields are excluded. Example includes=club

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    },
  • "error": { }
}

product

APIs for product information.

1. API get product by event id

The API will provide information about products by event_id.

path Parameters
event_id
required
string

ID of the events.

query Parameters
excludes
string

Exclude sth information of api. Example: excludes=attendant_template

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": [
    ],
  • "error": { }
}

2. API get product attraction by event id

The API will provide information about attraction products by event_id.

path Parameters
attraction_id
required
string

ID of the events.

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": [
    ],
  • "error": { }
}

attendant template

APIs for attendant template information.

1. API get attendant template by id

The Attendant Template Retrieval API fetches detailed information about individual attendant template using their unique IDs.

path Parameters
template_id
required
string

ID of the attendant template.

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    },
  • "error": { }
}

result

APIs for information of participant, bib, distance.

1. Result participants with paging

This will be the api that returns attendee data in an event with pagination. Supports searching by category and searching by name or bib.

path Parameters
event_id
required
string
page
required
integer
header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    }
}

checkout

APIs for checkout information.

1. API create order

This API will create an order, including information about the buyer and the ticket chosen by the user. In response, an ID is provided, which can be used to list all payment methods and proceed with the checkout.

path Parameters
event_id
required
string

ID of event selected.

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Request Body schema:
required
required
object

Buyer information

required
Array of objects (Ticket)

List of tickets

Responses

Request samples

Content type
{
  • "customer": {
    },
  • "tickets": [
    ]
}

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    }
}

2. API get list payment methods

This API provides a list of payment methods after creating an order.

path Parameters
cart_id
required
string

ID of cart created.

event_id
required
string

ID of event selected.

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": [
    ]
}

3. API checkout order

This API will be used when the user checks out with their payment method.

path Parameters
cart_id
required
string

ID of cart created.

event_id
required
string

ID of event selected.

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Request Body schema:
required
payment_method
required
string

Payment method

required
object

Payment option

Responses

Request samples

Content type
{
  • "payment_method": "string",
  • "payment_option": {
    }
}

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    }
}

4. API update order status

This API will be used when you don't use the Actiup payment gateway. Use this API to update the status of the order.

path Parameters
order_code
required
string

Order code of your order.

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    }
}

5. API get order list

This API will be used to list all orders of user by their email.

header Parameters
Accept-Language
string
Default: en
Enum: "en" "vi"

This value will return the message according to the language you input.

Authorization
required
string
Default: Bearer {}

This is the field that determines the authentication of the api. Format: Authorization {token}, read more

Request Body schema:
required
email
required
string

Email address of user

Responses

Request samples

Content type
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "result": true,
  • "message": "string",
  • "code_status": 0,
  • "data": {
    }
}