Backend API

Baserow разделён на два компонента: бэкенд и веб-фронтенд, которые общаются друг с другом через REST API. На этой странице содержится некоторая документация об этих эндпоинтах и о том, как их использовать. Эти эндпоинты не следует использовать для отображения данных на вашем собственном веб-сайте, так как это означало бы, что вам придётся раскрывать свои учётные данные или JWT токен. Они должны использоваться только для внесения изменений в ваши данные. Вы можете безопасно публично отображать свои данные, создав токен базы данных, установив разрешения и следуя автоматически сгенерированной документации API по адресу https://baserow.io/api-docs.

В будущем будут добавлены функции, позволяющие безопасно публично отображать ваши данные.

OpenAPI спецификация

Полная спецификация API доступна здесь: https://api.baserow.io/api/redoc/. Вы найдёте документацию и некоторые примеры для каждого эндпоинта. Спецификацию OpenAPI также можно скачать в формате JSON по адресу: https://api.baserow.io/api/schema.json.

Аутентификация

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

POST /api/user/
Host: api.baserow.io
Content-Type: application/json

{
  "name": "Bram",
  "email": "bram@localhost.com",
  "password": "your_password"
}

или

curl -X POST -H 'Content-Type: application/json' -i https://api.baserow.io/api/user/ --data '{
  "name": "Bram",
  "email": "bram@localhost.com",
  "password": "your_password"
}'

Сервер должен ответить кодом состояния 200, что означает, что ваша учётная запись создана. Предоставленный адрес электронной почты будет вашим именем пользователя. Более подробная информация об этом эндпоинте доступна в документации API по адресу: https://api.baserow.io/api/redoc/#operation/create_user.

Теперь, когда вы создали учётную запись, вам нужен JWT токен для авторизации каждого последующего запроса. Это можно сделать с помощью следующего примера.

POST /api/user/token-auth/
Host: api.baserow.io
Content-Type: application/json

{
  "username": "bram@localhost.com",
  "password": "your_password"
}

или

curl -X POST -H 'Content-Type: application/json' -i https://api.baserow.io/api/user/token-auth/ --data '{
  "username": "bram@localhost.com",
  "password": "your_password"
}'

Если вы просмотрите JSON-ответ, вы заметите ключ с именем 'token'. Его значение — это токен, который вам нужен для всех остальных запросов. Более подробная информация об этом эндпоинте доступна в документации API по адресу: https://api.baserow.io/api/redoc/#operation/token_auth. Вы можете просто предоставить заголовок Authorization с содержимым JWT {TOKEN} для авторизации. Токен будет действителен в течение 60 минут и может быть обновлён до истечения этого времени с помощью эндпоинта: https://api.baserow.io/api/redoc/#operation/token_refresh.

Следующий пример перечислит все рабочие пространства, принадлежащие вашей учётной записи. Когда вы только что создали учётную запись, автоматически было создано примерное рабочее пространство. Более подробная информация об этом эндпоинте доступна в документации API по адресу: https://api.baserow.io/api/redoc/#operation/list_workspaces.

GET /api/workspaces/
Host: api.baserow.io
Content-Type: application/json
Authorization: JWT {YOUR_TOKEN}

или

curl -X GET -H 'Content-Type: application/json' -H 'Authorization: JWT {YOUR_TOKEN}' -i 'https://api.baserow.io/api/workspaces/'

Общие проблемы

415 Unsupported Media Type

Если вы когда-либо получаете ошибку "Unsupported media type", скорее всего, вам нужно добавить следующий HTTP-заголовок к вашему запросу. Это необходимо, чтобы сервер знал, что тело вашего запроса находится в формате JSON.

Content-Type: application/json