Terminals

Terminals related endpoints

Get a single terminal

get

https://api.vaix.aihttps://staging-api.vaix.ai

/api/sports/terminals/{id}

This returns the terminal corresponding to the provided id

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The terminal id to get

Query parameters

operatorstringOptional

The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.

bookmaker_idintegerOptional

The bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the sub_bookmaker_id parameter.

sub_bookmaker_idintegerOptional

The sub-bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the bookmaker_id parameter.

Header parameters

x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses

200

OK

application/json

API response

statusstring · enumOptional

The status of the request

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

406

Not Acceptable

application/json

413

Request Entity Too Large

application/json

422

Unprocessable Entity

application/json

425

Too Early

application/json

500

Internal Server Error

application/json

get

/api/sports/terminals/{id}

HTTPcURLJavaScriptPython

GET /api/sports/terminals/{id} HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*

{
  "data": {
    "id": "110914",
    "shop": {
      "address_1": null,
      "address_2": null,
      "city": "Marousi",
      "country_code": "10",
      "id": "5",
      "is_final_shop_transfer": null,
      "region": "Attica",
      "shop_name": null,
      "shop_transfer_id": null,
      "status_code": null,
      "street": null,
      "type_code": null,
      "zip_code": null
    },
    "terminal_name": null,
    "terminal_type": null
  },
  "status": "success"
}

Lists all terminals

get

https://api.vaix.aihttps://staging-api.vaix.ai

/api/sports/terminals

This returns a list of all registered terminals. For each terminal, any information available for the shop it belongs to will also be returned.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filtersstring · enumOptional

Optional filtering of the terminal devices to retrieve. It expects a string adhering to the filtering format, as described in the filtering section.

Possible values:

order_bystring · enumOptional

The columns to sort the results by. It expects a string adhering to the ordering format, as described in the ordering section, e.g. +id,-terminal_name.

Possible values:

operatorstringOptional

The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.

bookmaker_idintegerOptional

The bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the sub_bookmaker_id parameter.

sub_bookmaker_idintegerOptional

The sub-bookmaker id to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored. Note that this parameter is used together with the bookmaker_id parameter.

Header parameters

x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses

200

OK

application/json

API response

statusstring · enumOptional

The status of the request

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

406

Not Acceptable

application/json

413

Request Entity Too Large

application/json

422

Unprocessable Entity

application/json

425

Too Early

application/json

500

Internal Server Error

application/json

get

/api/sports/terminals

HTTPcURLJavaScriptPython

GET /api/sports/terminals HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*

{
  "data": [
    {
      "id": "110914",
      "shop": {
        "address_1": null,
        "address_2": null,
        "city": "Marousi",
        "country_code": "10",
        "id": "5",
        "is_final_shop_transfer": null,
        "region": "Attica",
        "shop_name": null,
        "shop_transfer_id": null,
        "status_code": null,
        "street": null,
        "type_code": null,
        "zip_code": null
      },
      "terminal_name": null,
      "terminal_type": null
    },
    {
      "id": "125198",
      "shop": {
        "address_1": null,
        "address_2": null,
        "city": "Marousi",
        "country_code": "10",
        "id": "875",
        "is_final_shop_transfer": null,
        "region": "Attica",
        "shop_name": null,
        "shop_transfer_id": null,
        "status_code": null,
        "street": null,
        "type_code": null,
        "zip_code": null
      },
      "terminal_name": null,
      "terminal_type": null
    }
  ],
  "status": "success"
}