Files
kontur-focus-lib/docs/focus.rst
2025-03-18 16:32:54 +03:00

64 lines
1.6 KiB
ReStructuredText
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
=====
Фокус
=====
Подготовка
----------
Создайте файл `.env` или добавьте в существующий параметры:
- `FOCUS_BASE_URL=<kontur_url>`
- `FOCUS_ACCESS_KEY=<your_access_key>`
Где `kontur_url` - адрес REST API Контур.Фокус. Например, `https://focus-api.kontur.ru/api3`.
А `FOCUS_ACCESS_KEY` - секретный ключ доступа к REST API Контур.Фокус.
Инициализация
-------------
.. code-block:: python
from kontur_focus import Focus
focus = Focus(inn='<inn_string>', ogrn='<ogrn_string>')
Обязательный параметр - **ИНН**.
Основные методы
---------------
Пример использования методов:
.. code-block:: python
focus.base_info()
Юридические лица
----------------
.. autofunction:: kontur_focus.Focus.base_info()
.. autofunction:: kontur_focus.Focus.advanced_info()
.. autofunction:: kontur_focus.Focus.excerpt(path)
Пример вывода результат по отчету:
.. code-block:: python
{'success': True, 'filename': '<имя_файла>', 'path': '<полный_путь_файла>'}
.. autofunction:: kontur_focus.Focus.express_report(pdf, path)
Пример вывода результат по отчету:
.. code-block:: python
{'success': True, 'filename': '<имя_файла>', 'path': '<полный_путь_файла>'}
.. autofunction:: kontur_focus.Focus.founders_history()
.. autofunction:: kontur_focus.Focus.foreign_representatives()