Информация о Сервере ER:LC

curl --request GET \
  --url https://api.erlcrussia.xyz/v2/erlc/server \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.erlcrussia.xyz/v2/erlc/server"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.erlcrussia.xyz/v2/erlc/server', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.erlcrussia.xyz/v2/erlc/server",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.erlcrussia.xyz/v2/erlc/server"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.erlcrussia.xyz/v2/erlc/server")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.erlcrussia.xyz/v2/erlc/server")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "Name": "API Test",
  "OwnerId": 1,
  "CoOwnerIds": [
    1
  ],
  "CurrentPlayers": 1,
  "MaxPlayers": 1,
  "JoinKey": "APIServer",
  "AccVerifiedReq": "Disabled",
  "TeamBalance": true,
  "Players": [
    {
      "Team": "Sheriff",
      "Player": "PlayerName:Id",
      "Callsign": "5D-550",
      "Location": {
        "LocationX": 1084.965,
        "LocationZ": 2302.28,
        "PostalCode": "218",
        "StreetName": "Park Street",
        "BuildingNumber": "2083"
      },
      "Permission": "Normal / Server Administrator / Server Owner / Server Co-Owner / Server Moderator",
      "WantedStars": 0
    }
  ],
  "Staff": {
    "Admins": {
      "54249787": "Black_Hallow",
      "77573259": "sli_ckk"
    },
    "Mods": {
      "2": "JohnDoe",
      "3": "JaneDoe"
    },
    "Helpers": {
      "168691872": "Flat_bird"
    }
  },
  "JoinLogs": [
    {
      "Join": true,
      "Timestamp": 1704614400,
      "Player": "PlayerName:Id"
    }
  ],
  "Queue": [
    1
  ],
  "KillLogs": [
    {
      "Killed": "PlayerName:Id",
      "Timestamp": 1704614400,
      "Killer": "PlayerName:Id"
    }
  ],
  "CommandLogs": [
    {
      "Player": "PlayerName:Id",
      "Timestamp": 1704614400,
      "Command": ":h"
    }
  ],
  "ModCalls": [
    {
      "Caller": "PlayerName:Id",
      "Moderator": "PlayerName:Id",
      "Timestamp": 1704614400
    }
  ],
  "EmergencyCalls": [
    {
      "Team": "Police",
      "Caller": 68691872,
      "Players": [
        789012
      ],
      "Position": [
        -654.6,
        666.5
      ],
      "StartedAt": 1774216563,
      "CallNumber": 43,
      "Description": "stg",
      "PositionDescriptor": "sdfsdfsdf"
    }
  ],
  "Vehicles": [
    {
      "Name": "Redline Fire Engine",
      "Owner": "Shawnyg",
      "Texture": "Livery Name",
      "ColorHex": "#ff4444",
      "ColorName": "Super Red"
    }
  ]
}

ER:LC API V2

Информация о Сервере ER:LC

Получение общей информации о сервере ER:LC.

Дополнительные поля могут быть включены путём установки query-параметров в значение ‘true’. Все query-параметры необязательны.

GET

erlc

server

Информация о Сервере ER:LC

curl --request GET \
  --url https://api.erlcrussia.xyz/v2/erlc/server \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.erlcrussia.xyz/v2/erlc/server"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.erlcrussia.xyz/v2/erlc/server', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.erlcrussia.xyz/v2/erlc/server",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.erlcrussia.xyz/v2/erlc/server"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.erlcrussia.xyz/v2/erlc/server")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.erlcrussia.xyz/v2/erlc/server")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "Name": "API Test",
  "OwnerId": 1,
  "CoOwnerIds": [
    1
  ],
  "CurrentPlayers": 1,
  "MaxPlayers": 1,
  "JoinKey": "APIServer",
  "AccVerifiedReq": "Disabled",
  "TeamBalance": true,
  "Players": [
    {
      "Team": "Sheriff",
      "Player": "PlayerName:Id",
      "Callsign": "5D-550",
      "Location": {
        "LocationX": 1084.965,
        "LocationZ": 2302.28,
        "PostalCode": "218",
        "StreetName": "Park Street",
        "BuildingNumber": "2083"
      },
      "Permission": "Normal / Server Administrator / Server Owner / Server Co-Owner / Server Moderator",
      "WantedStars": 0
    }
  ],
  "Staff": {
    "Admins": {
      "54249787": "Black_Hallow",
      "77573259": "sli_ckk"
    },
    "Mods": {
      "2": "JohnDoe",
      "3": "JaneDoe"
    },
    "Helpers": {
      "168691872": "Flat_bird"
    }
  },
  "JoinLogs": [
    {
      "Join": true,
      "Timestamp": 1704614400,
      "Player": "PlayerName:Id"
    }
  ],
  "Queue": [
    1
  ],
  "KillLogs": [
    {
      "Killed": "PlayerName:Id",
      "Timestamp": 1704614400,
      "Killer": "PlayerName:Id"
    }
  ],
  "CommandLogs": [
    {
      "Player": "PlayerName:Id",
      "Timestamp": 1704614400,
      "Command": ":h"
    }
  ],
  "ModCalls": [
    {
      "Caller": "PlayerName:Id",
      "Moderator": "PlayerName:Id",
      "Timestamp": 1704614400
    }
  ],
  "EmergencyCalls": [
    {
      "Team": "Police",
      "Caller": 68691872,
      "Players": [
        789012
      ],
      "Position": [
        -654.6,
        666.5
      ],
      "StartedAt": 1774216563,
      "CallNumber": 43,
      "Description": "stg",
      "PositionDescriptor": "sdfsdfsdf"
    }
  ],
  "Vehicles": [
    {
      "Name": "Redline Fire Engine",
      "Owner": "Shawnyg",
      "Texture": "Livery Name",
      "ColorHex": "#ff4444",
      "ColorName": "Super Red"
    }
  ]
}

Авторизации

Authorization

string

header

обязательно

Стандартный API ключ для доступа к ER:LC эндпоинтам.

Передается в заголовке Authorization: Bearer <ключ>.

ОБЯЗАТЕЛЕН ДЛЯ ВСЕХ ER:LC ЭНДПОИНТОВ.

Параметры запроса

Players

boolean

Включить список игроков в ответ.

Staff

boolean

Включить список персонала (Admins, Mods, Helpers) в ответ.

JoinLogs

boolean

Включить логи входов/выходов в ответ.

Queue

boolean

Включить данные очереди в ответ.

KillLogs

boolean

Включить логи убийств в ответ.

CommandLogs

boolean

Включить логи команд в ответ.

ModCalls

boolean

Включить логи вызовов модераторов в ответ.

EmergencyCalls

boolean

Включить логи вызовов экстренных служб в ответ.

Vehicles

boolean

Включить список транспорта в ответ.

Ответ

Успешный ответ с информацией о сервере. Дополнительные поля включаются только при соответствующих query-параметрах.

Информация о сервере ER:LC v2 API.

Дополнительные поля (Players, Staff, JoinLogs, Queue, KillLogs, CommandLogs, ModCalls, Vehicles) включаются только при соответствующих query-параметрах.

Name

string

обязательно

Название сервера.

Пример:

"Moscow RolePlay"

OwnerId

integer

обязательно

Discord ID владельца сервера.

Пример:

123456

CoOwnerIds

integer[]

обязательно

Массив Discord ID совладельцев сервера.

Пример:

[789012]

CurrentPlayers

integer

обязательно

Текущее количество игроков на сервере.

Пример:

50

MaxPlayers

integer

обязательно

Максимальное количество игроков.

Пример:

100

JoinKey

string

обязательно

Ключ для подключения к серверу.

Пример:

"MRPServer"

AccVerifiedReq

string

обязательно

Требование верификации аккаунта (Disabled/Email/Phone/ID).

Пример:

"Email"

TeamBalance

boolean

обязательно

Включён ли баланс команд.

Пример:

true

Players

object[]

Список игроков. Включается только при query-параметре Players=true.

Show child attributes

Staff

object

Информация о персонале сервера.

Show child attributes

JoinLogs

object[]

Логи входов/выходов. Включается только при query-параметре JoinLogs=true.

Show child attributes

Queue

integer[]

Очередь на сервер. Включается только при query-параметре Queue=true.

Пример:

[1, 2, 3]

KillLogs

object[]

Логи убийств. Включается только при query-параметре KillLogs=true.

Show child attributes

CommandLogs

object[]

Логи команд. Включается только при query-параметре CommandLogs=true.

Show child attributes

ModCalls

object[]

Логи вызовов модераторов. Включается только при query-параметре ModCalls=true.

Show child attributes

EmergencyCalls

object[]

Логи вызовов экстренных служб. Включается только при query-параметре EmergencyCalls=true.

Show child attributes

Vehicles

object[]

Список транспорта. Включается только при query-параметре Vehicles=true.

Show child attributes

Выполнение Команды на Сервере