Ко всем статьям

Гайд по Free API

Подробный гайд по Free API: создание записей, получение данных, FIFO, лимиты и query-параметры.

5 мин чтения

Free API — это REST API, которое позволяет сразу создавать, получать, изменять и удалять собственные JSON-записи без предварительной настройки коллекций.

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

В отличие от Collections API, здесь не нужно сначала создавать коллекцию. Вы просто отправляете JSON в API и сразу получаете готовую запись с id.

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

Возможности и лимиты#

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

Free API поддерживает до 30 записей одновременно.

Размер одной записи может быть любым JSON-объектом, если он не превышает 5 KB.

Лимит использования — 100 запросов в минуту.

Как работает FIFO#

Главная особенность Free API — автоматическая работа по принципу FIFO.

Если вы добавите новую запись после достижения лимита в 30 элементов, самая старая запись будет удалена автоматически, а новая сохранится на её месте.

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

В Collections API поведение другое: там при достижении лимита нужно сначала удалить одну из старых записей вручную. В Free API этот процесс полностью автоматический.

Создание первой записи#

Для создания записи нужно отправить POST - запрос на:

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

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

Где:

  • id — уникальный идентификатор записи
  • payload — ваш JSON-объект
  • createdAt — время создания записи
  • updatedAt — время последнего обновления

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

Если вам нужна одна конкретная запись, используйте её id:

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

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

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

Чтобы получить все доступные записи, отправьте GET - запрос на:

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

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

Информацию о rate limits можно посмотреть в response headers.

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

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

Free API поддерживает query-параметры для более удобной работы со списками.

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

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

  • page — номер страницы
  • limit — количество записей в ответе
  • sort — сортировка по id записи. Доступные значения: ASC и DESC

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

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

Обновление записи#

Для обновления записи используется PATCH - запрос:

Важно: Free API полностью перезаписывает объект. Если вы хотите изменить только одно поле, всё равно передавайте остальные поля в прежнем виде.

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

Удаление записи#

Для удаления записи используется DELETE - запрос:

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

При успешном удалении API возвращает статус 204 No Content.

Playground#

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

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

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