Updated docs
This commit is contained in:
30
docs/focus-compliance.rst
Normal file
30
docs/focus-compliance.rst
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
==========================
|
||||||
|
Библиотека Фокус.Комплаенс
|
||||||
|
==========================
|
||||||
|
|
||||||
|
Подготовка
|
||||||
|
----------
|
||||||
|
|
||||||
|
Создайте файл `.env` или добавьте в существующий параметры:
|
||||||
|
|
||||||
|
- `FOCUS_COMPLIANCE_BASE_URL=<kontur_url>`
|
||||||
|
- `FOCUS_COMPLIANCE_ACCESS_KEY=<your_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='<inn_string>', ogrn='<ogrn_string>')
|
||||||
|
|
||||||
|
Обязательный параметр - **ИНН**.
|
||||||
|
|
||||||
|
|
||||||
|
Основные методы
|
||||||
|
---------------
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
=============
|
================
|
||||||
Использование
|
Библиотека Фокус
|
||||||
=============
|
================
|
||||||
|
|
||||||
Подготовка
|
Подготовка
|
||||||
----------
|
----------
|
||||||
@@ -16,4 +16,4 @@ documentation for details.
|
|||||||
:caption: Contents:
|
:caption: Contents:
|
||||||
|
|
||||||
setup
|
setup
|
||||||
usage
|
focus
|
||||||
|
|||||||
13
docs/openapi.yml
Normal file
13
docs/openapi.yml
Normal file
@@ -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
|
||||||
Reference in New Issue
Block a user