Getloo Space для разработчиков

Appearance

Обзор ​

В этом руководстве — всё необходимое для начала работы с API Getloo Space.

API (Application Programming Interface) — это готовый набор инструментов для взаимодействия вашего приложения с платформой Getloo Space. Он предоставляет стандартные методы для доступа к данным и функциям, что ускоряет и упрощает разработку интеграций.

Важно

Для безопасности всегда используйте HTTPS соединение!

Поддерживаемые методы ​

Наше API использует стандартные HTTP-методы для выполнения операций с данными. Каждый метод соответствует конкретному типу действия:

  • GET — чтение ресурсов (получение данных).
  • POST — создание ресурсов (отправка данных на сервер).
  • PATCH — частичное обновление ресурса.
  • DELETE — удаление ресурса.

Передача данных ​

В HTTP-запросах данные можно передавать двумя основными способами:

Параметры в URL (Query Parameters) ​

Используются в GET-запросах для фильтрации, поиска и настройки выборки данных.

GET https://space.getloo.ru/api/1/users/{userId}/transactions?start_date=2022-02-24

Тело запроса (Request Body) ​

Используется в POST, PUT, PATCH запросах для передачи структурированных данных. Формат — JSON

bash
curl -X POST https://space.getloo.ru/api/v1/wa/apps/{appId}/messages \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "79991234567",
    "type": "IMAGE",
    "image": {
      "url": "https://cdn.getloo.ru/0a25506e-66df-4120-93bf-85260b172d50.jpg",
      "caption": "Hello Dude!"
    }
  }'
json
{
  "phone": "79991234567",
  "type": "IMAGE",
  "image": {
    "url": "https://cdn.getloo.ru/0a25506e-66df-4120-93bf-85260b172d50.jpg",
    "caption": "Hello Dude!"
  }
}

Данные ответа ​

Все ответы нашего API имеют единую структуру для простоты и предсказуемости обработки.

Для одного объекта:

json
{
  "id": 1,
  "name": "MyAwesomeApplication",
  "embed_link_url": "https://link.getloo.ru/Ae26_PR3"
}

Для списка объектов:

json
[
  {
    "id": "6949404bfb7e3563a5dbdccf",
    "app_id": 9,
    "amount": -2.1,
    "currency": "RUB",
    "status": "DELIVERED",
    "category": "MARKETING",
    "recipient_phone": "7***",
    "timestamp": 1766408267
  },
  {
    "id": "694945ec4c17bacbfd9ae7e4",
    "app_id": 9,
    "amount": -2.1,
    "currency": "RUB",
    "status": "DELIVERED",
    "category": "MARKETING",
    "recipient_phone": "7***",
    "timestamp": 1766409708
  }
]

Коды ответов HTTP ​

  • 200 OK — успешный запрос
  • 201 Created - ресурс создан
  • 204 No Content - успешный запрос но дынные результата пусты
  • 400 Bad Request — недействительный запрос
  • 401 Unauthorized — ошибка аутентификации
  • 404 Not Found — ресурс не найден
  • 422 Unprocessable Content - необрабатываемый экземпляр, балланс закончился
  • 429 Too Many Requests — Превышен лимит запросов
  • 500 Internal Server Error - внутренняя ошибка сервреа
  • 503 Service Unavailable — сервис недоступен

Авторизация ​

Для доступа к защищённым эндпоинтам API требуется авторизация. Мы используем стандартную схему Bearer Token (носителя). Токен может быть двух типов: токен реального пользователя, токен системного пользователя.

Пример использования ​

bash
curl -X POST https://space.getloo.ru/api/v1/wa/apps/{appId}/messages \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
js
// javascript
fetch('https://space.getloo.ru/api/v1/wa/apps/{appId}/messages', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer ваш_токен',
    'Content-Type': 'application/json',
  },
});

Группы методов API ​

Для удобства навигации все методы API сгруппированы по функциональным разделам:

Users ​

Методы для управления пользователями, их профилями и настройками аккаунтов. Информация по транзакциям пользователей и пополнения баланса счета

Apps (WABA) ​

Методы для управления приложениями (WABA) и профилями приложений

Events subscriptions (webhooks) ​

Templates ​

Методы для работы с шаблонами

Messages ​

Методы для работы с сообщениями