Гайд по Collections API

Collections API — это REST API, которое позволяет создавать собственные коллекции и хранить в них JSON-данные.

Его удобно использовать в frontend-проектах, когда нужен простой backend без отдельного сервера: для demo-приложений, тестовых заданий, учебных проектов, портфолио и внутренних инструментов.

Можно создать до 3 коллекций. В каждой коллекции может быть до 30 записей, а каждая запись может содержать любой JSON-объект.

Формат каждого ответа соответствует формату JSend.

Видимость коллекции#

Коллекция может быть private или public.

private означает, что доступ к коллекции есть только с API-ключом. С ключом можно читать, создавать, изменять и удалять записи.
public означает, что коллекцию можно читать без API-ключа. При этом для создания, изменения и удаления записей API-ключ всё равно обязателен. Это позволяет делиться коллекцией публично, но не отдавать управление данными посторонним пользователям.

Удалить саму коллекцию можно только через личный кабинет. Даже если API-ключ будет скомпрометирован, через API нельзя удалить коллекцию целиком. Под угрозой могут быть только записи внутри неё.

Создание коллекции#

Пример создания коллекции с именем students:

Пример ответа:

После создания коллекции URL будет выглядеть так:

Где:

namespace — уникальный namespace аккаунта. Он создаётся один раз и остаётся статичным
name — имя коллекции
namespace и name можно найти в личном кабинете после создания коллекции. Также namespace возвращается в ответе API

Добавление данных в коллекцию#

После создания коллекции вы можете добавлять в неё свои данные.

Пример запроса на создание первой записи:

Максимальное количество записей в одной коллекции — 30.

Если лимит будет превышен, вы не сможете добавить новые записи. Чтобы создать новую запись, сначала удалите одну из старых.

Получение записей коллекции#

Пример запроса на получение записей из коллекции students:

Для всех коллекций доступно 2000 запросов в день. Информацию о rate limits можно посмотреть в response headers.

Пример заголовков:

Query-параметры#

После добавления данных в коллекцию можно использовать query-параметры, чтобы управлять ответом.

Они необязательны, но делают API удобнее для реальных интерфейсов: списков, таблиц, пагинации и сортировки.

Доступные параметры:

page — номер страницы
limit — количество записей в ответе. Например, при значении 1 вернётся только одна запись.
sort — сортировка по id записи. Доступные значения: ASC и DESC. id создаётся автоматически при добавлении записи.

Пример запроса:

Пример ответа:

items — массив записей.
payload — ваш JSON-объект, который был передан при создании записи.
meta — информация о пагинации, сортировке, лимитах и наличии следующей страницы.

Playground#

Ссылка на API содержит встроенный playground, где можно проверить запросы прямо из браузера.

API-ключ подставляется автоматически после авторизации. Это удобно для быстрых тестов, проверки структуры ответов и отладки запросов без отдельного клиента.

Перейти на страницу Collections API