.. _`API Экстерна для работы с учетными записями и организациями`: https://developer.kontur.ru/doc/extern
.. _`API Экстерна для работы с черновиками и конструктором черновиков (draftsbuilder)`: https://developer.kontur.ru/doc/extern.drafts
.. _`API Экстерна для работы с документооборотами и лентой событий`: https://developer.kontur.ru/doc/extern.docflows
.. _`API Экстерна для работы с сервисом контентов`: https://developer.kontur.ru/doc/extern.contents
.. _`API Экстерна для работы со сверкой по НДС`: https://developer.kontur.ru/doc/extern.nds 
.. _`Тестовая площадка`:  https://extern-api.testkontur.ru/
.. _`Рабочая площадка`: https://extern-api.kontur.ru/
.. _`Вопросы и ответы по отчетности`: https://www.kontur-extern.ru/support/faq
.. _`Extern Test Tools`: https://developer.kontur.ru/doc/extern.test.tools
.. _`сертификат электронной подписи`: https://kontur.ru/ca/spravka/36-iz_chego_sostoit_sertifikat_elektronnoj_podpisi

API Контур Экстерна
===================

.. image:: /logo.png
   :width: 550

.. toctree::
   :caption: История изменений 
   :titlesonly:
   :hidden:
   
   release notes

.. toctree::
   :maxdepth: 2 
   :caption: Подготовка
   :hidden:
   
   recommendations
   howto/index
   auth_oidc/index
   specification/index
   knowledge base/index
   
.. toctree::
   :maxdepth: 2  
   :caption: Работа с API
   :hidden:
   
   accounts/index
   drafts/index
   dc/index
   inventories/index
   builder/index
   contents/index
   sverkaNds/index
   
.. toctree::
   :maxdepth: 2 
   :caption: Дополнительно
   :hidden:
   
   manuals/index
   contacts
   SDK
   auth/index

API позволяет интегрировать сервис отчетности с контролирующими органами в ваши процессы и информационные системы.

Контур.Экстерн является сервисом отчетности, который обеспечивает электронный документооборот между хозяйствующими субъектами и контролирующими органами. Веб сервис обладает рядом преимуществ, но не всегда может поддержать уникальные сценарии пользователя. API Контур.Экстерна нужен, чтобы встроить работу с электронным документооборотом отчетности в интерфейсы информационных систем клиента.

Интеграционные возможности 
==========================

Использование API Контур.Экстерна позволяет: 

1. Авторизовать пользователя в его в учетной записи Контур.Экстерна. 
2. Создать черновик отчета и подготовить его к отправке в контролирующие органы, такие как ФНС, ФСС, ПФР, Росстат.
3. Отправить сформированную отчетность в контролирующий орган.
4. Отследить и завершить документооборот с контролирующим органом. API позволяет создать все необходимые технологические документы.
5. Настроить централизованный мониторинг отчетности для любой организационной структуры — вы сможете следить за статусами документооборотов и настроить для себя уведомления по изменениям в них.
6. Автоматизировать работу с требованиями — вы сможете настроить массовую загрузку поступивших требований в вашу информационную систему. Пользователи смогут формировать и отправлять ответ на требование без ограничения на количество и объем отправляемых документов.
7. Организовать зашифрованный или расшифрованный архив отчетов в вашей информационной системе или локальном хранилище.

Модели сотрудничества
=====================

.. image:: /_static/firstPage.png
   :width: 600px

Абонент Контур.Экстерна
-----------------------

Если вы автоматизируете процессы отчетности в своей компании или холдинге, то вы сможете внедрить Контур.Экстерн в свою корпоративную информационную систему. Ваши пользователи будут работать в привычном для них интерфейсе, а API Контур.Экстерна станет инструментом для проверки и передачи данных из вашей информационной системы в контролирующие органы.  

Компания-партнер Контур.Экстерна
--------------------------------

Если вы разрабатываете или уже продаете свою информационную систему, и хотите расширить ее функциональность в части электронного документооборота с контролирующими органами — вам не нужно получать статус оператора ЭДО. Ваша система будет взаимодействовать с контролирующими органами в соответствии с законодательством через API Контур.Экстерна. Вашим клиентам достаточно будет получить учетную запись в Экстерне, и они смогут работать с отчетностью в вашей системе по вашим тарифам.

С чего начать
=============

Для начала работы с API Контур.Экстерна:

* Получите :doc:`/auth_oidc/api-key`.
* Заключите договор с Контуром. 
* Пройдите :doc:`аутентификацию</auth_oidc/index>` и получите Access Token. 
* Для криптографических операций необходимо иметь `сертификат электронной подписи`_. 

Тестирование сервиса
====================

Если вы сомневаетесь, подходит ли вам наш API, мы предоставляем широкий выбор инструментов для тестирования. Вы сможете самостоятельно изучить документацию. А если хотите попробовать поработать с методами, напишите нам на extern-api@skbkontur.ru. Мы вышлем тестовый api-key, учетную запись с  тестовым сертификатом и заполненными данными, чтобы вы могли отправлять запросы и познакомиться с API. В сервисе `Extern Test Tools`_ вы можете сгенерировать тестовые данные, которые можно использовать на тестовой площадке.

Полезные ссылки
===============

* Документация Swagger:

  *  `API Экстерна для работы с учетными записями и организациями`_ .
  *  `API Экстерна для работы с черновиками и конструктором черновиков (draftsbuilder)`_ . 
  *  `API Экстерна для работы с документооборотами и лентой событий`_ .
  *  `API Экстерна для работы с сервисом контентов`_ .
  *  `API Экстерна для работы со сверкой по НДС`_ .

* `Тестовая площадка`_ 
* `Рабочая площадка`_
* `Вопросы и ответы по отчетности`_
* `Extern Test Tools`_ — сервис для генерации тестовых данных, которые можно использовать на тестовой площадке.