diff --git a/docs/focus-compliance.rst b/docs/focus-compliance.rst new file mode 100644 index 0000000..f80f044 --- /dev/null +++ b/docs/focus-compliance.rst @@ -0,0 +1,30 @@ +========================== +Библиотека Фокус.Комплаенс +========================== + +Подготовка +---------- + +Создайте файл `.env` или добавьте в существующий параметры: + +- `FOCUS_COMPLIANCE_BASE_URL=` +- `FOCUS_COMPLIANCE_ACCESS_KEY=` + +Где `kontur_url` - адрес REST API Контур.Фокус. Например, `https://kyc.kontur.ru/api`. + +А `FOCUS_ACCESS_KEY` - секретный ключ доступа к REST API Контур.Фокус. + +Инициализация +------------- + +.. code-block:: python + + from kontur_focus import Focus + + focus = Focus(inn='', ogrn='') + +Обязательный параметр - **ИНН**. + + +Основные методы +--------------- \ No newline at end of file diff --git a/docs/usage.rst b/docs/focus.rst similarity index 94% rename from docs/usage.rst rename to docs/focus.rst index 2b053a3..5e6b231 100644 --- a/docs/usage.rst +++ b/docs/focus.rst @@ -1,6 +1,6 @@ -============= -Использование -============= +================ +Библиотека Фокус +================ Подготовка ---------- diff --git a/docs/index.rst b/docs/index.rst index 39c6120..2ff981c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,4 +16,4 @@ documentation for details. :caption: Contents: setup - usage + focus diff --git a/docs/openapi.yml b/docs/openapi.yml new file mode 100644 index 0000000..ae4571d --- /dev/null +++ b/docs/openapi.yml @@ -0,0 +1,13 @@ +openapi: '3.0.3' +info: + title: Kontur Focus and Compliance REST API Library + version: '1.0' +servers: + - url: https://focus-api.kontur.ru/api3 + - url: https://kyc.kontur.ru/api +paths: + /test: + get: + responses: + '200': + description: OK