{"id":23240747,"url":"https://github.com/skbkontur/extern-java-sdk","last_synced_at":"2025-10-08T05:29:57.183Z","repository":{"id":31436188,"uuid":"113544603","full_name":"skbkontur/extern-java-sdk","owner":"skbkontur","description":"SDK для работы с API Контур.Экстерна для платформы JVM","archived":false,"fork":false,"pushed_at":"2025-02-24T08:43:34.000Z","size":11681,"stargazers_count":26,"open_issues_count":4,"forks_count":7,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-08-20T01:40:46.034Z","etag":null,"topics":["api","extern","java","kontur","sdk"],"latest_commit_sha":null,"homepage":"https://extern-api.kontur.ru/swagger","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/skbkontur.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-12-08T07:21:10.000Z","updated_at":"2025-02-24T08:43:38.000Z","dependencies_parsed_at":"2023-11-14T18:44:23.914Z","dependency_job_id":"f3c22037-2aba-49fa-a3a6-e702a3703234","html_url":"https://github.com/skbkontur/extern-java-sdk","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/skbkontur/extern-java-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skbkontur%2Fextern-java-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skbkontur%2Fextern-java-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skbkontur%2Fextern-java-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skbkontur%2Fextern-java-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skbkontur","download_url":"https://codeload.github.com/skbkontur/extern-java-sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skbkontur%2Fextern-java-sdk/sbom","scorecard":{"id":515377,"data":{"date":"2025-08-11","repo":{"name":"github.com/skbkontur/extern-java-sdk","commit":"80fbd38a5080ccafad7d960ec3a87cbb5bf83a73"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.8,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":2,"reason":"Found 3/11 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":4,"reason":"binaries present in source code","details":["Warn: binary detected: extern-api-java-sdk/repo/ru/argosgrp/cryptoservice/asn1/5.0.22/asn1-5.0.22.jar:1","Warn: binary detected: extern-api-java-sdk/repo/ru/argosgrp/cryptoservice/cs-mscapi/5.0.22/cs-mscapi-5.0.22.jar:1","Warn: binary detected: extern-api-java-sdk/repo/ru/argosgrp/cryptoservice/cs-openssl/5.0.22/cs-openssl-5.0.22.jar:1","Warn: binary detected: extern-api-java-sdk/repo/ru/argosgrp/cryptoservice/cs-util/5.0.22/cs-util-5.0.22.jar:1","Warn: binary detected: extern-api-java-sdk/repo/ru/argosgrp/cryptoservice/cs/5.0.22/cs-5.0.22.jar:1","Warn: binary detected: extern-api-java-sdk/repo/ru/argosgrp/cryptoservice/pkcs/5.0.22/pkcs-5.0.22.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 22 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-j288-q9x7-2f5v"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T01:40:48.472Z","repository_id":31436188,"created_at":"2025-08-20T01:40:48.472Z","updated_at":"2025-08-20T01:40:48.472Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278891993,"owners_count":26063903,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","extern","java","kontur","sdk"],"created_at":"2024-12-19T05:13:51.998Z","updated_at":"2025-10-08T05:29:57.140Z","avatar_url":"https://github.com/skbkontur.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SDK для работы с API Контур.Экстерна\r\n\r\n[![Maven Central](https://img.shields.io/maven-central/v/ru.kontur.extern-api/extern-api-java-sdk.svg)](https://mvnrepository.com/artifact/ru.kontur.extern-api/extern-api-java-sdk)\r\n[![oss.sonatype](https://img.shields.io/nexus/s/https/oss.sonatype.org/ru.kontur.extern-api/extern-api-java-sdk.svg)](https://oss.sonatype.org/content/repositories/snapshots/ru/kontur/extern-api/extern-api-java-sdk/)\r\n\r\n![License](https://img.shields.io/github/license/skbkontur/extern-java-sdk.svg)\r\n\r\nПредназначен для интеграции внешних систем с [API Контур.Экстерна](https://github.com/skbkontur/extern-api-docs). \r\nБиблиотека предоставляет классы и методы для работы с сервисами СКБ Контур.\r\n\r\n## Подключение SDK к проекту\r\n\r\n### Указать библиотеку как зависимость из [maven.central](https://mvnrepository.com/artifact/ru.kontur.extern-api/extern-api-java-sdk):\r\n\r\n##### maven\r\n```xml\r\n\u003cdependency\u003e\r\n  \u003cgroupId\u003eru.kontur.extern-api\u003c/groupId\u003e\r\n  \u003cartifactId\u003eextern-api-java-sdk\u003c/artifactId\u003e\r\n  \u003cversion\u003e${version}\u003c/version\u003e\r\n\u003c/dependency\u003e\r\n```\r\n\r\n##### gradle\r\n```groovy\r\ndependencies {\r\n  compile group: 'ru.kontur.extern-api', name: 'extern-api-java-sdk', version: '${version}'\r\n}\r\n```\r\n\r\n#### [Использовать SNAPSHOT версии sdk](https://stackoverflow.com/questions/7715321/how-to-download-snapshot-version-from-maven-snapshot-repository)\r\n\r\n##### maven\r\n\r\nДля использования SNAPSHOT версий sdk нужно разрешить использование **sonatype snapshot repository**.\r\nДля этого добавьте в ` ~/.m2/settings.xml`\r\n```xml\r\n\u003cprofiles\u003e\r\n  \u003cprofile\u003e\r\n     \u003cid\u003eallow-snapshots\u003c/id\u003e\r\n        \u003cactivation\u003e\u003cactiveByDefault\u003etrue\u003c/activeByDefault\u003e\u003c/activation\u003e\r\n     \u003crepositories\u003e\r\n       \u003crepository\u003e\r\n         \u003cid\u003esnapshots-repo\u003c/id\u003e\r\n         \u003curl\u003ehttps://oss.sonatype.org/content/repositories/snapshots\u003c/url\u003e\r\n         \u003creleases\u003e\u003cenabled\u003efalse\u003c/enabled\u003e\u003c/releases\u003e\r\n         \u003csnapshots\u003e\u003cenabled\u003etrue\u003c/enabled\u003e\u003c/snapshots\u003e\r\n       \u003c/repository\u003e\r\n     \u003c/repositories\u003e\r\n   \u003c/profile\u003e\r\n\u003c/profiles\u003e\r\n```\r\n\r\n##### build.gradle\r\n```groovy\r\nrepositories {\r\n    maven {\r\n        url \"https://oss.sonatype.org/content/repositories/snapshots\"\r\n    }\r\n}\r\n```\r\n\r\nSnapshot версии полезно использовать для активной разработки, оперативного исправления багов\r\nи получения самых свежих обновлений. \r\n\r\n### Версионирование\r\n\r\nИнформацию самых новых версиях sdk можно найти [здесь](https://github.com/skbkontur/extern-java-sdk/releases) \r\n\r\n[![Maven Central](https://img.shields.io/maven-central/v/ru.kontur.extern-api/extern-api-java-sdk.svg)](https://mvnrepository.com/artifact/ru.kontur.extern-api/extern-api-java-sdk)\r\n[![oss.sonatype](https://img.shields.io/nexus/s/https/oss.sonatype.org/ru.kontur.extern-api/extern-api-java-sdk.svg)](https://oss.sonatype.org/content/repositories/snapshots/ru/kontur/extern-api/extern-api-java-sdk/)\r\n\r\n\u003e указывать без префикса `v`\r\n\r\nНазвание тега соответствует существующей версии sdk в maven.central или версии snapshot'а в\r\nрепозитории oss.sonatype.org\r\n\r\n### Компиляция из исходного кода:\r\n\r\n1. Склонировать репозиторий SDK:\r\n    ```cmd\r\n    git clone git@github.com:skbkontur/extern-java-sdk.git\r\n    ```\r\n    \r\n1. Собрать и установить проект в локальный maven репозиторий\r\n (пропуская шаг интеграционных тестов: о них будет ниже):\r\n    ```cmd\r\n    mvn clean install -DskipITs\r\n    ```\r\n    \r\n1. Добавить в `pom.xml` проекта артефакт `extern-api-java-sdk`:\r\n    ```xml\r\n    \u003cdependency\u003e\r\n        \u003cgroupId\u003eru.kontur.extern-api\u003c/groupId\u003e\r\n        \u003cartifactId\u003eextern-api-java-sdk\u003c/artifactId\u003e\r\n        \u003cversion\u003e${extern-api-java-sdk.version}\u003c/version\u003e\r\n    \u003c/dependency\u003e\r\n    ```\r\n\r\n## Конфигурирование\r\nДля того чтобы начать работу с SDK, необходимо создать и сконфигурировать `ExternEngine`.\r\nДля этого стоит воспользоваться `ExternEngineBuilder`.\r\nНапример, для базового создания движка с аутентификацией по сертификату код будет выглядеть так:\r\n\r\n```java\r\nExternEngine ee = ExternEngineBuilder\r\n        .createExternEngine(\"http://extern-api.testkontur.ru\")\r\n        .apiKey(\"ваш api-key\")\r\n        .buildAuthentication(\"http://api.testkontur.ru\", authBuilder -\u003e authBuilder\r\n                .certificateAuthentication(/* place certificate content here */)\r\n        )\r\n        .doNotUseCryptoProvider()\r\n        .doNotSetupAccount()\r\n        .build()\r\n```\r\n\r\nБольше информации можно найти в документации к коду или на [wiki проекта](https://github.com/skbkontur/extern-java-sdk/wiki/Get-started-%5Bsince-1.6%5D).\r\n\r\n### Аутентификация\r\n\r\n1. **Api-Key** – идентификатор, который выдается *сервису*, от которого отправляются запросы к API СКБ Контура.\r\n\r\n2. **AuthenticationProvider** – провайдер токена аутентификации *пользователя*\r\n    (см. [auth.sid](https://docs-ke.readthedocs.io/ru/latest/auth/index.html)). Чтобы создать провайдеры для\r\n    стандартных методов аутентификации можно воспользоваться `AuthenticationProviderBuilder`.\r\n\r\n### Account:\r\n\r\n- **AccountId** — предоставляет идентификатор аккаунта, который передается при отправки данных на сервис.\r\n    Данный идентификатор связан с лицевым счетом в системе СКБ Контур. UUID.\r\n    (см. ExternEngine#setAccountId)\r\n    \r\n### CryptoProvider\r\n    \r\n  - Реализация для работы с [MSCapi](https://msdn.microsoft.com/en-us/library/windows/desktop/aa380256.aspx) - класс `CryptoProviderMSCap`;\r\n    Предназначена для вычисления электронной подписи и расшифрования зашифрованных документов, с использованием алгоритмов ГОСТ.\r\n    Для расшифрования и вычисления электронной подписи требуется доступный ключевой носитель, содержащий сертификат открытого ключа.\r\n  - Реализация для RSA-криптографии `CryptoProviderRSA`.\r\n    Предназначена для подписания идентификационных данных для доверительной аутентификации.\r\n     Конструктор принимает на вход пароль для ключевого хранилища **JAVA** (**JKS**) и пароль для секретного ключа. \r\n     Если в качестве паролей передать значение **null**, то это будет означать его отсутствие.\r\n\r\n\r\n\r\n## Архитектура\r\nВ SDK реализован класс **ExternEngine**, обеспечивающий доступ к операциям Контур Экстерн. Все операции разделены на следующие группы:\r\n\r\n- сервис для работы с учетными записями конечных пользователей (**AccountService**);\r\n- сервис для получения информации о сертификатах конечных пользователей (**CertificateService**);\r\n- сервис для работы со списком организаций (**OrganizationService**);\r\n- сервис для работы с черновиками (**DraftService**);\r\n- сервис для работы с документооборотами (**DocflowService**);\r\n- сервис для работы с лентой событий (**EventService**).\r\n\r\nДля получения доступа к сервису необходимо у объекта ExternEngine вызвать соответствующий метод \r\nтипа **get\u003cимя сервиса\u003e**. Например для того чтобы получить доступ к операциям сервиса для работы \r\nс учетными записями необходимо использовать метод **getAccountService()**, который вернет экземпляр класса, \r\nреализующий интерфейс **AccountService**. \r\n\r\n\r\n#### QueryContext\r\n\r\nWarning! Всё что здесь написано имеет место, но не является рекомендуемым сценарием использования SDK\r\nтак как является местом потенциальных ошибок отсутствия параметров в контексте.\r\n\r\n##### Актуальная информация\r\n\r\n* Методы использующие `QueryContext` в качестве входного параметра помечены `@Deprecated` и\r\nбудут удалены в следующих версиях\r\n\r\n* `QueryContext` возвращаемый из метода предназначен только для\r\n    * получения результата метода в случае успеха `.get()`\r\n    * получения/пробрасывания сервисной ошибки `ApiException`: `.isFail()`/`.getServiceError()`/`.getOrThrow()`\r\n  \r\n##### Deprecated\r\n  \r\n\u003e Класс **QueryContext** содержит коллекцию типа **Map**, для сохранения входных и выходных параметров. \r\nДля каждого используемого параметра существует свой сеттер, \r\nнапример, для установки передаваемого контента есть метод **setContent**. \r\n\r\n\u003e Как уже упоминалось выше, метод **isFail** возвращает признак операции, завершившейся с ошибкой. \r\nВ этом случае метод **getServiceError** вернет ошибку. Если операции выполнилась успешно, \r\nто метод **isSuccess** вернет истину, а метод **get** результат операции, \r\nкоторый указан в качестве параметра класса **QueryContext**. \r\nБолее подробное описание смотри в **javadoc**.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskbkontur%2Fextern-java-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskbkontur%2Fextern-java-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskbkontur%2Fextern-java-sdk/lists"}