Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Smartis API package. Architecture solution with 2 endpoints connection example.

Notifications You must be signed in to change notification settings

3gr1v750v/smartis_api

Repository files navigation

Пакет для подключения к Smartis API

Описание проекта

Реализация пакета для подключения к эндпоинтам Smartis API (https://my.smartis.bi/). Архитектурное решение содержит примеры подключение к двум эндпоинтам: "/reports/getReport" и "/reports/getKeywords". Подключение к остальным эндпоинтам Smartis API может быть реализовано аналогично текущему паттерну в классе SmartisAPIEndpoints (api_client.py).

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

В основном исполняемом файле проекта (main.py) предоставлен пример использования пакета smartis_api на примере к эндпоинту "/reports/getReport".

Установка и запуск (локальный)

  1. Скопируйте репозиторий и перейдите в него в командной строке:
git clone git@github.com:3gr1v750v/smartis_api.git
cd smartis_api
  1. Создайте и активируйте виртуальное окружение:
python -m venv env
source env/bin/activate
  1. Установите зависимости из файла requirements.txt:
python -m pip install --upgrade pip
pip install -r requirements.txt
  1. Создайте '.env' фаил в директории "smartis_api":

Демо-токен предоставлен в документации Smartis API (https://my.smartis.bi/api/documentation)

API_TOKEN = <your_api_token_here>
  1. Если вы используете демо-токен, можете запустить тесты проверки работы эндпоинтов:
python -m tests.smartis_api_endpoints_test
  1. Запустите проект:
python main.py

About

Smartis API package. Architecture solution with 2 endpoints connection example.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

AltStyle によって変換されたページ (->オリジナル) /