---
title: "Эндпоинты REST API | Tajo"
description: "Документация по эндпоинтам REST API"
url: https://tajo.io/ru/docs/endpoints/rest-api/
markdown: https://tajo.io/ru/docs/endpoints/rest-api.md
lang: ru-RU
author: "Set Noa"
author_url: https://tajo.io/ru/set-noa/
robots: noindex
---

Подайте заявку на ранний доступ

Укажите имя и рабочий адрес электронной почты. Мы отправим ссылку для подтверждения запроса на доступ к Tajo.

# Эндпоинты REST API

[Set Noa](https://tajo.io/ru/set-noa/)

Caution

**Демонстрационная страница**: это демонстрационная страница, показывающая возможность многовкладочной документации. Её содержимое приведено исключительно для иллюстрации.

Наш REST API предоставляет эндпоинты для доступа к данным и работы с ними. Все эндпоинты возвращают данные в формате JSON.

## Базовый URL

Все запросы к API следует отправлять на следующий базовый URL:

```
https://api.example.com/v1
```

## Эндпоинты пользователей

### Получить всех пользователей

```http
GET /users
```

Возвращает список всех пользователей. Поддерживает параметры постраничного вывода.

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

| Параметр | Тип | Описание |
| --- | --- | --- |
| page | integer | Номер страницы (по умолчанию: 1) |
| limit | integer | Количество записей на странице (по умолчанию: 50, максимум: 100) |
| sort | string | Поле для сортировки (например, «name», «created\_at») |

**Ответ:**

```json
{
  "data": [
    {
      "id": "user_123",
      "name": "John Doe",
      "email": "john@example.com",
      "created_at": "2023-01-15T08:30:00Z"
    },
    // More users...
  ],
  "meta": {
    "total": 250,
    "page": 1,
    "limit": 50
  }
}
```

### Получить пользователя по ID

```http
GET /users/{id}
```

Возвращает одного пользователя по идентификатору.

**Ответ:**

```json
{
  "data": {
    "id": "user_123",
    "name": "John Doe",
    "email": "john@example.com",
    "created_at": "2023-01-15T08:30:00Z",
    "profile": {
      "bio": "Software developer",
      "location": "New York",
      "avatar_url": "https://example.com/avatars/john.jpg"
    }
  }
}
```

## Эндпоинты товаров

### Получить все товары

```http
GET /products
```

Возвращает список всех товаров. Поддерживает фильтрацию и постраничный вывод.

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

| Параметр | Тип | Описание |
| --- | --- | --- |
| category | string | Фильтр по категории |
| min\_price | number | Фильтр по минимальной цене |
| max\_price | number | Фильтр по максимальной цене |
| page | integer | Номер страницы (по умолчанию: 1) |
| limit | integer | Количество записей на странице (по умолчанию: 50, максимум: 100) |

**Ответ:**

```json
{
  "data": [
    {
      "id": "prod_123",
      "name": "Example Product",
      "description": "This is an example product",
      "price": 49.99,
      "category": "electronics"
    },
    // More products...
  ],
  "meta": {
    "total": 350,
    "page": 1,
    "limit": 50
  }
}
```

## Обработка ошибок

Все эндпоинты используют стандартные коды состояния HTTP и при необходимости содержат подробные сообщения об ошибках:

| Код состояния | Описание |
| --- | --- |
| 200 | OK: запрос выполнен успешно |
| 400 | Bad Request: недопустимые параметры |
| 401 | Unauthorized: требуется аутентификация |
| 403 | Forbidden: недостаточно прав |
| 404 | Not Found: ресурс не существует |
| 429 | Too Many Requests: превышен лимит частоты запросов |
| 500 | Internal Server Error: произошла ошибка на сервере |

Ответы с ошибкой содержат сообщение, объясняющее, что пошло не так:

```json
{
  "error": {
    "code": "invalid_parameter",
    "message": "The parameter 'email' is not a valid email address",
    "request_id": "req_abc123"
  }
}
```