UI клиент для сервера ГАР m3-rest-gar
Project description
Пакет m3-gar-client предоставляет панель для ввода адресов Российской Федерации с использованием ГАР (Государственного адресного реестра), готовую к использованию в проектах на базе платформы M3 компании БАРС Груп.
Возможности
Работа с сервером ГАР m3-rest-gar.
Встраивание в интерфейс веб-приложений на базе ExtJS.
Поиск адресов в ГАР по мере ввода наименований адресных объектов (субъектов Федерации, населенных пунктов, улиц, зданий).
Системные требования
Подключение в варианте M3
Установка:
$ pip install m3-gar-client[m3]
Настройка:
INSTALLED_APPS += [
'testapp',
'rest_framework',
'm3_gar_client',
]
GAR_API_URL = 'http://gar.bars.group/gar/v1/'
GAR = dict(
BACKEND='m3_gar_client.backends.m3_rest_gar.proxy', # <---
URL=GAR_API_URL,
USE_CACHE=True,
USE_SIMPLE_SERVER=True,
)
Подключение в варианте REST
Установка:
$ pip install m3-gar-client[rest]
Настройка:
INSTALLED_APPS += [
'testapp',
'rest_framework',
'm3_gar_client',
]
GAR_API_URL = 'http://gar.bars.group/gar/v1/'
GAR = dict(
BACKEND='m3_gar_client.backends.m3_rest_gar.proxy_rest', # <---
URL=GAR_API_URL,
USE_CACHE=True,
USE_SIMPLE_SERVER=True,
REST=dict(
AUTHENTICATION_CLASSES=[
'oidc_auth.authentication.JSONWebTokenAuthentication'
],
PERMISSION_CLASSES=[
'rest_framework.permissions.IsAuthenticated'
]
)
)
Настройки
URL — URL API сервера ГАР.
TIMEOUT — timeout запроса к серверу ГАР в секундах.
PAGE_LIMIT — количество страниц запрашиваемых у m3-rest-gar, по умолчанию 1. При большом количестве можно заддосить ГАР
USE_CACHE — определяет необходимость кеширования HTTP-запросов к серверу m3-rest-gar. Значение по умолчанию: False
CACHE_TIMEOUT — определяет длительность кэширования (в секундах). Значение по умолчанию: 24 часа
USE_SIMPLE_SERVER — Использовать простой сервер, по умолчанию будет использоваться сервер OAUTH2
OAUTH2 — параметры OAuth2: необходиы если не указано использовать простой сервер
TOKEN_URL — URL для получения токена, должен использоваться HTTPS.
CLIENT_ID — id клиента - создается на стороне РЕСТ сервера
CLIENT_SECRET — Секретный ключ клиента - генерируется на стороне РЕСТ сервера
USERNAME — username пользователя для получения токена
PASSWORD — password пользователя для получения токена
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for m3_gar_client-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a734c45bf34420bdcb4a495ed639c5768242f37b9c4745dd453e3e6546f6d832 |
|
MD5 | 2f8a641834401e615e344eb878fb7aa3 |
|
BLAKE2b-256 | bd70e99372b3ddfa3ba8a44769ec8ca3caada6618803693d4fa81c43d3b10b74 |