Начало работы с API

Подробное объяснение для разработчиков

Настройка в панели

1

Первым делом необходимо зайти в панель, во вкладу "API".

2

Разбираем все пункты подробно

  1. Секретный ключ - это строка, которую необходимо указывать в хедере Authorization, выдает полный доступ прав к панели. Никому не сообщать

  2. Authorization key - дополнительный параметр, его указывать необязательно, нужен лишь для того, чтоб на ваш callback не мог стучаться никто, кроме сервера панели

  3. IPN Callback URL - ссылка на ваш сервер, https-only. Например, указав сюда example.com, при получении депозита сервер отправит запрос вам на example.com/api/new_deposit. Подробнее про уведомления здесь

3

Делаем запросы к API

import axios from "axios";

const client = axios.create({
    baseURL: "https://elysium-panel.com/api/"
});


// Пример запросов:
await client.get("/users");
await client.get("/user/:id/transactions");
await client.post("/fake_bets")

Поведение API

Для начала, базовый URL для отправки запросов к API — это https://elysium-panel.com/api/

Все ответы от сервера приходят в одном и том же формате:

{
   "success": true,
   "message": "Сообщение",
   "data": {
      "any": "data"
   }
}

Если success = false, очевидно что-то пошло не так, обычно ошибка сама о себе говорит в message, но если вы получили ошибку "Something went wrong" без видимой на то причины, напишите сюда

Пагинация

Для большей части запросов, потенциально содержащих большое количество объектов, предусмотрена серверная пагинация, осуществляемая через URL параметры. Ниже пример

Подробно разберем каждый параметр:

  • days— Промежуток времени, за который нужно спарсить те или иные значения, выражается в днях. Напр. если days = 7, то парсятся промокоду, добавленные в течение последних 7 дней. Примечение: если days = 0, не будет никакого фильтра.

  • search — Ключевое слово, по которому будет производиться поиск, на всех эндпоинтах таргет по которым идет поиск отличается. Где-то это почта мамонта, где-то название. Уточнение есть у каждого эндпоинта индивидуально.

  • page — Страница, которую нужно будет спарсить. Например если у вас 1000 юзеров, page = 1, take = 200, вы получите первых 200 пользователей. Если page станет 2, то соответственно те первые 200 будут проигнорированы и пойдут следующие.

  • take — Сколько позиций брать за запрос. Все просто, если хотите, чтоб вам пришло 200 позиций, указываете take = 200, если хотите ограничиться 10, указываете 10.

Last updated