Краткая инструкция по SDK для API категоризации доменов SkyDNS (C реализация)

SDK достаточно просто интегрировать в конечный программный продукт, разрабатываемый на языке программирования Си или Си++. В этом материале мы предоставим ссылки на инструкции для подготовки библиотеки к интеграции, а также покажем сборку быстрого примера для демонстрации функций.

Прочитать полную техническую документацию на SDK API можно по адресу — https://docs.skydns.ru/url2cat-lib/ В ней подробно расписаны основные задачи решения, конфигурирование библиотек, этапы интеграции, а также даны приложения со справочными материалами.

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

Этапы конфигурирования библиотеки url2cat:

• Подготовка. Для конфигурирования и сборки библиотеки вам в обязательном порядке понадобятся:
  - утилиты cmake (версии 3.15 или выше), make-4.2, gcc.
  - библиотеки openssl-1.1.1g.
• Сборка. Зайдите в каталог с исходниками библиотеки. Сконфигурируйте ее, используя следущую команду:
  > rm -rf build_release
  > cmake -S . -B build_release -DCMAKE_BUILD_TYPE=Release -DURL2CAT_SERVER=yes -DURL2CAT_DATABASE=yes -DURL2CAT_LIBRARY=static -DURL2CAT_LOCALE=en   
  где -B build_release указывает название каталога для сборки
  
  Изменяя следующие переменные можно настроить функции библиотеки:
  
  URL2CAT_SERVER — запросы к серверу SkyDNS (yes, no);
  URL2CAT_DATABASE — запросы к локальной БД (yes , no);
  URL2CAT_LOCALE — формат отображения категорий (ru, en);
  URL2CAT_LIBRARY — тип создаваемой библиотеки (static, shared);
  URL2CAT_MAX_NUMBER_CATEGORY — количество определяемых категорий (по умолчанию 5);
  URL2CAT_HASH_TYPE — тип хеша (MD5, SHA256, SHA512, по умолчанию MD5);
  URL2CAT_HASH_LEN — используемая длина хеша (full (хеш не обрезается перед поиском по базе), half (берётся 8 первых Байт хеша), по умолчанию half).
  
  Соберите библиотеку, используя команду:
  > cmake --build build_release
• Установка библиотеки.
  > cmake --install build_release --prefix install_dir
  где install_dir каталог для установки собранной библиотеки
  
  После  выполнения инструкции у вас будет:
  - install_dir/lib/liburl2cat.a — собранная библиотека.
  - install_dir/include/url2cat.h — копия заголовочного файла для интеграции.
  - build_release/bin/client — собранный семпл для тестирования с параметрами указанными в example/client.c.

При необходимости вы можете найти нужную документацию в формате ReST в скачанном архиве (ссылка выше) по пути doc/ru/index.rst.