Библиотека для работы с Airtable (open-source)

Если вы не слышали ранее об Открытом Пакете Интеграций (что вполне вероятно), то небольшая вводная часть ниже, под катом. Для тех, кто уже знаком с ОПИ, данный раздел можно пропустить.

Airtable - облачная служба, позволяющая легко создавать и использовать реляционные базы данных, информация в которых будет хранится онлайн, на облаке сервиса


Мне лично Airtable очень напоминает Notion: оба сервиса имеют функционал как для создания самих баз данных, так и для организации ввода-вывода информации из них в различных формах, однако, если Notion позиционирует себя скорее как инструмент для ведения заметок и планирования задач, то Airtable делает фокус на хранение и использование данных в виде электронных таблиц. Содержащуюся там информацию, в дальнейшем, можно выводить в диаграммы и графики, что делает рассматриваемый сегодня сервис куда более применимым для нашей, так сказать, 1С-специфики

Но прежде чем мы перейдем к обзору работы с Airtable, рассмотрим список методов, которые были добавлены в данном обновлении:

• Методы работы с базами
  • Получение списка баз
  • Получения списка таблиц базы
  • Создание базы
• Методы работы с таблицами
  • Создание таблицы
  • Изменение таблицы
• Методы работы с полями таблиц
  • Создание поля
  • Изменение поля
  • Получение макетов полей: строкового, числового и пр.
• Методы работы с записями таблиц
  • Получение списка записей таблицы
  • Получение значения полей записи
  • Создание записи
  • Удаление записи
• Методы работы с комментариями
  • Получение списка комментариев записи
  • Создание комментария к записи
  • Изменение комментария к записи
  • Удаление комментария

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

Работа с сервисом

Кратенько рассмотрим принципы работы с Airtable

Основной способ взаимодействия с данным сервисом - веб-интерфейс по адресу airtable.com. Зарегистрировавшись и войдя в аккаунт, первым делом, вы можете создать базу данных и структуру таблиц для хранения информации под свои конкретные нужды.

Слегка плюшевая, но вполне стандартная табличная структура работы с данными: база -> таблица -> поля таблицы и записи. Редактор же напоминает больше интерфейс Google Sheet, нежели какого-нибудь SQL Studio  - этакий компромисс между гибкостью серьезных СУБД и простотой электронных таблиц

Для организации хранения, в Airtable доступно множество различных типов полей: числовые, строковые, поля вложений, даты, ссылки, выбора варианта и пр. Каждый из них имеет свой особенный способ отображения в конструкторе таблиц, а также набор присущих только ему настраиваемых параметров. Помимо этого, особняком, есть и поля для связи таблиц между собой. В конструкторе по их значениям можно легко переходить для определения отношений двух строк из разных сущностей

Ничего необычного, но главный вопрос: "А зачем вообще хранить информацию в Airtable?"

Публикация таблиц

Начнем с простого: любую базу, по окончании настройки, можно сделать публично доступной на просмотр. На выбор есть 3 варианта организации доступа: по email, ссылке-приглашеню (и первый и второй вариант - для пользователей Airtbale), а также свободный доступ по публичному URL

При этом, разместить можно как всю базу целиком, так и лишь какой-нибудь конкретны View - заранее настроенный способ отображения таблицы. Так, можно, например, скрыть какие-нибудь колонки таблицы не для общего показа, настроить сортировку и фильтры данных, сгруппировать строки по определенным признакам и значениям полей

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

Интерфейсы

Следующим, после хранения и публикации, является функционал создания интерфейсов и форм. Под "интерфейсами" в Airtable подразумеваются способы визуализации данных: календари, галереи, канбан-доски и всякие другие красивые дашборды:

Строятся они, как не трудно догадаться, на основе наших заранее созданных таблиц. Сам процесс довольно интуитивный - основа вообще настраивается в мастере, где нужно просто тыкать подходящие варианты в выпадающих списках

Далее, в основном редакторе интерфейсов, уже можно настроить все более детально. Есть несколько видов диаграмм, также можно выводить табличные и текстовые расшифровки отображаемых данных. Сам же вывод будет динамически обновляться при изменение данных в БД

Формы

Помимо визуализации информации, в Airtbale еще есть инструментарий для создания форм заполнения и получения входных данных. Эти формы, также как и графики, создаются на основе полей таблиц, а принцип действия схож с таковым у любых других сервисов для сбора обратной связи, вроде Google Forms -  заполненные пользователем данные, после подтверждения отправки, сохраняются в учетной системе

После окончания настройки формы,  как и в случае таблиц/графиков, она может быть бесплатно опубликована по общедоступному адресу. Данные, введенные в нее пользователем, автоматически трансформируются в строки родительской таблицы, на которой форма основана. При необходимости, доступ к заполнению можно ограничивать паролями или по домену

В итоге у нас получается два основных сценария использования Airtbale (исключая возможность просто хранить там данные, конечно же):

1. Визуализация хранимых данных в виде различных графиков и диаграмм
2. Сбор данных из онлайн форм для последующего использования

При помощи интеграции мы сможем оперировать этими данными прямо из 1С - как на вход, так и на выход. Применение придумать не сложно: онлайн дашборд, как замена отчетам в 1С (с визуальной точки зрения - функционала, сравнимого с СКД, тут нету), дополнительное место для облачного хранения отчетных данных, механизм получения в 1С информации из форм для сбора обратной связи любых видов. Ниже приведено несколько примеров кода на 1С для лучшего понимания:
 

  Токен               = "***";
  РабочееПространство = "wspdf8yl1yZz3PmWZ";	
  Наименование        = "Тестовая база";

  МассивПолей = Новый Массив;
  МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеНомера("Номер"));
  МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСтроковое("Строковое"));
  
  ИмяТаблицы = "Тестовая таблица";
  
  КоллекцияТаблиц = Новый Соответствие;
  КоллекцияТаблиц.Вставить(ИмяТаблицы, МассивПолей);

  Ответ = OPI_Airtable.СоздатьБазу(Токен, РабочееПространство, Наименование, КоллекцияТаблиц);

  Токен        = "***"; 
  База         = "apptm8Xqo7TwMaipQ";
  Наименование = "Тестовая таблица 2";
  Описание     = "Новая таблица";

  МассивПолей = Новый Массив;
  МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеНомера("Номер"));
  МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСтроковое("Строковое"));
  МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеВложения("Вложение"));
  МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеФлажка("Флажок"));
  МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеДаты("Дата"));
  МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеТелефона("Телефон"));
  МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеПочты("Почта"));
  МассивПолей.Добавить(OPI_Airtable.ПолучитьПолеСсылки("Ссылка"));

  Ответ = OPI_Airtable.СоздатьТаблицу(Токен, База, Наименование, МассивПолей, Описание);

  Токен        = "***";
  База         = "apptm8Xqo7TwMaipQ";
  Таблица      = "tbl9G4jVoTJpxYwSY";
  Имя          = "НовоеПолеНомера";
  Поле         = OPI_Airtable.ПолучитьПолеНомера(Имя);

  Ответ = OPI_Airtable.СоздатьПоле(Токен, База, Таблица, Поле);

  Токен    = "***";
  База     = "apptm8Xqo7TwMaipQ";
  Таблица  = "tbl9G4jVoTJpxYwSY";
  Числовой = 10;
  Строчный = "Привет";

  ОписаниеСтроки1 = Новый Структура("Номер,Строковое", Числовой, Строчный);
  ОписаниеСтроки2 = Новый Структура("Номер,Строковое", Числовой, Строчный);
    
  Данные  = Новый Массив;
  Данные.Добавить(ОписаниеСтроки1);
  Данные.Добавить(ОписаниеСтроки2);

  Ответ = OPI_Airtable.СоздатьЗаписи(Токен, База, Таблица, Данные);

  Токен   = "***";
  База    = "apptm8Xqo7TwMaipQ";
  Таблица = "tbl9G4jVoTJpxYwSY";

  Ответ = OPI_Airtable.ПолучитьСписокЗаписей(Токен, База, Таблица);

  Токен   = "***";
  База    = "apptm8Xqo7TwMaipQ";
  Таблица = "tbl9G4jVoTJpxYwSY";

  Записи = Новый Массив;
  Записи.Добавить("recjHNKNZBWLZkZ7A");
  Записи.Добавить("recGyJ0MlN1H3GMuN");

  Ответ = OPI_Airtable.УдалитьЗаписи(Токен, База, Таблица, Запись);

Еще больше примеров можно найти в документации

В заключении

Вот такой интересный сервис. Мы пробежались по верхам, но в Airtable есть еще много чего интересного, а Открытый пакет интеграций обязательно поможет вам организовать простое и удобное с ним взаимодействие.

Напоминаю, что функционал всех библиотек ОПИ, включая и эту, доступен в трех вариантах: расширения для 1С, пакета для OneScript и приложения для командной строки (CLI)

Ну и оцените обновленную страницу репозитория и новый интерфейс документации - по-моему, получилось отлично :)

Спасибо за внимание!

Репозиторий ОПИ: github.com/Bayselonarrend/OpenIntegrations

Последний релиз: github.com/Bayselonarrend/OpenIntegrations/releases/latest

Другие статьи про Открытый пакет интеграций на Инфостарт:

• Открытый пакет интеграций для популярных API: Telegram, VK, Viber, Twitter

• Работа с Notion API | Обновление Открытого пакета интеграций

• Библиотека работы с Яндекс Диском (Open-source) 

• Открываем свою лавку на платформе VK Market

• Библиотека для работы с Google Calendar API (open-source) 

• Telegram в режиме форума: делаем чаты комфортными

• Открытый пакет интеграций для OneScript

• Библиотека для работы с Google Drive API (open-source)

• OInt CLI - приложение Открытого пакета интеграций для командной строки

• Библиотека для работы со Slack (open-source)

 

 Мой GitHub:     https://gitub.com/Bayselonarrend 
 Лицензия MIT:   https://mit-license.org