ESIA-Adapter : 8.7.4.1. Справки о доходах

[ Назначение сценария ] [ Требования к настройке ЕСИА ] [ Вызовы API ЕСИА ] [ Данные, передаваемые приложению ] [ Конфигурация провайдера ] [ Ограничения и особенности ] [ Проверка ] [ Полный пример конфигурации ]

Назначение сценария

Получить справки 2-НДФЛ и сведения о доходах и страховых взносах: оценка платёжеспособности, кредитование.

Требования к настройке ЕСИА

Области доступа: openid; в согласии ndfl_person (2-НДФЛ) и payout_income (доходы и взносы)
Согласие: онлайн-режим, permissions
Система зарегистрирована в ЕСИА, сертификат загружен (подключение).

Вызовы API ЕСИА

GET /digital/api/public/v1/pso/{oid}/doc/INCOME_REFERENCE и .../PAYOUT_INCOME (в исходном виде .../PAYOUT_INCOME/raw?permissionId=<id>)

Данные, передаваемые приложению

INCOME_REFERENCE: массив по годам, year, data[].orgInfo, incInfo[] (rate, income, tax), файлы XML/PDF с подписью. PAYOUT_INCOME: content.xmlFile/pdfFile и подпись sig

Конфигурация провайдера

Фрагменты конфигурации внешнего провайдера; полный пример — в конце страницы. Значения в <...> задаются при настройке: это параметры конкретной установки.

Шаги конвейера после проверки токена и is_trusted:

[
  {
    "t": 0,
    "r": "person",
    "m": "GET",
    "u": "{{.extidp_details.baseUrl}}/digital/api/public/v1/pso/{{printf \"%.0f\" .id_token_claims.sub}}",
    "h": {
      "Authorization": "Bearer {{.token.access_token}}"
    }
  },
  {
    "t": 0,
    "r": "income_ref",
    "m": "GET",
    "u": "{{.extidp_details.baseUrl}}/digital/api/public/v1/pso/{{printf \"%.0f\" .id_token_claims.sub}}/doc/INCOME_REFERENCE",
    "h": {
      "Authorization": "Bearer {{.token.access_token}}"
    }
  },
  {
    "t": 0,
    "r": "payout_income",
    "m": "GET",
    "u": "{{.extidp_details.baseUrl}}/digital/api/public/v1/pso/{{printf \"%.0f\" .id_token_claims.sub}}/doc/PAYOUT_INCOME",
    "h": {
      "Authorization": "Bearer {{.token.access_token}}"
    }
  }
]

Обработка ответа (JavaScript-шаг):

{
  "income_status": "r = \"no\"; d = income_ref; if (Array.isArray(d)) { if (d.length && d[0].error) { r = \"error\"; } else if (d.length && d[0].status) { r = \"yes\"; } else if (d.length && d[0].requestId) { r = \"pending\"; } else if (d.length && d[0].statusDoc) { r = d[0].statusDoc; } } else if (d) { if (d.statusDoc) { r = d.statusDoc; } else if (d.requestId) { r = \"pending\"; } else if (d.error) { r = \"error\"; } else if (d.status) { r = \"yes\"; } } r;",
  "payout_income_status": "r = \"no\"; d = payout_income; if (Array.isArray(d)) { if (d.length && d[0].error) { r = \"error\"; } else if (d.length && d[0].status) { r = \"yes\"; } else if (d.length && d[0].requestId) { r = \"pending\"; } else if (d.length && d[0].statusDoc) { r = d[0].statusDoc; } } else if (d) { if (d.statusDoc) { r = d.statusDoc; } else if (d.requestId) { r = \"pending\"; } else if (d.error) { r = \"error\"; } else if (d.status) { r = \"yes\"; } } r;",
  "income_years": "r = \"\"; if (Array.isArray(income_ref)) { for (i = 0; i < income_ref.length; i++) { if (income_ref[i].year) { r += (r ? \",\" : \"\") + income_ref[i].year; } } } r;"
}

Отображение в атрибуты:

{
  "fn": "{{.person.firstName}}",
  "ln": "{{.person.lastName}}",
  "mn": "{{.person.middleName}}",
  "un": "",
  "e": "",
  "p": "",
  "l": "",
  "xid": "",
  "rid": "state",
  "x": {
    "income_years": "{{.income_years}}",
    "income_status": "{{.income_status}}",
    "payout_income_status": "{{.payout_income_status}}"
  }
}

Запрос согласия (параметр permissions в redirectForm, перед кодированием — JSON-массив):

[
  {
    "sysname": "<ТИП_СОГЛАСИЯ>",
    "scopes": [
      {
        "sysname": "ndfl_person"
      },
      {
        "sysname": "payout_income"
      }
    ],
    "purposes": [
      {
        "sysname": "<ЦЕЛЬ>"
      }
    ],
    "actions": [
      {
        "sysname": "ALL_ACTIONS_TO_DATA"
      }
    ],
    "responsibleObject": "<ФИО_ИЛИ_ПОДРАЗДЕЛЕНИЕ>",
    "expire": "<СРОК_В_МИНУТАХ>"
  }
]

scope в запросе авторизации — только openid; нужные области перечислены в согласии. expire — срок в минутах (262800 = 182,5 суток), не больше максимума типа согласия. <ТИП_СОГЛАСИЯ> и <ЦЕЛЬ> — мнемоники из реестров платформы согласий.

Ограничения и особенности

Данные запрашиваются в ФНС асинхронно: oid, year и requestId без данных — запрос ушёл, ответ позже.
Ошибки: ndflNotFound, MksRequestErrorEnum.fns.payout.income.doc.failed.no.data.
Файлы могут быть большими; в атрибуты рекомендуется передавать годы и признак наличия, а не содержимое.
В тесте ?test=1 отдаёт справку по заглушке.

Проверка

Провайдер включить (isActive: true) на тестовом стенде.
Пройти вход тестовой учётной записью ЕСИА.
Проверить /health/ready и атрибуты пользователя в приложении.
При ошибке смотреть журнал LOG_LEVEL=debug (диагностика).

Полный пример конфигурации

Файл конфигурации внешнего провайдера (extidp.json) целиком. Значение typeDetails — строка с JSON; значения в <...> задаются при настройке.

[
  {
    "id": "<UUID_ПРОВАЙДЕРА>",
    "redirectMethod": 0,
    "authorizeUri": "{{.extidp_details.baseUrl}}/aas/oauth2/v2/ac",
    "logoutRedirectMethod": 0,
    "logoutUri": "{{.extidp_details.baseUrl}}/aas/oauth2/api/logout",
    "logoutForm": {
      "redirect_url": "https://<адрес-после-выхода>",
      "client_id": "{{ .extidp_details.clientID }}"
    },
    "type": "esia",
    "name": "case5-income",
    "synonym": "esia",
    "typeDetails": "{\n  \"baseUrl\": \"https://esia-portal1.test.gosuslugi.ru\",\n  \"clientCertHash\": \"<ХЕШ_СЕРТИФИКАТА_ГОСТ_Р_34.11-2012_256>\",\n  \"clientID\": \"<MNEMONIC_ИС_В_ЕСИА>\",\n  \"cryptoProvider\": {\n    \"name\": \"cprocsp_raw\",\n    \"details\": {\n      \"certPath\": \"/opt/esia-adapter/certs/<сертификат_ИС>.cer\",\n      \"containerName\": \"<ИМЯ_КОНТЕЙНЕРА>\",\n      \"containerPIN\": \"<PIN_КОНТЕЙНЕРА>\",\n      \"sha1Thumbprint\": \"<SHA1_ОТПЕЧАТОК>\",\n      \"hashAlg\": \"GOST3411_2012_256\"\n    }\n  },\n  \"scope\": \"openid\",\n  \"scopeOrg\": \"\"\n}",
    "redirectForm": {
      "response_type": "code",
      "client_id": "{{ .extidp_details.clientID }}",
      "redirect_uri": "{{ .extidp_request.CallbackURI }}",
      "scope": "{{ .extidp_details.scope }}",
      "client_secret": "{{ $ts := timeFormat \"2006.01.02 15:04:05 Z0700\" .process_started }}{{ $clientSecretRaw := join .extidp_details.clientID .extidp_details.scope $ts .extidp_request.ID .extidp_request.CallbackURI }}{{ cryptoSign .context $clientSecretRaw .extidp_details.cryptoProvider | base64 }}",
      "client_certificate_hash": "{{ .extidp_details.clientCertHash }}",
      "timestamp": "{{ timeFormat \"2006.01.02 15:04:05 Z0700\" .process_started }}",
      "state": "{{ .extidp_request.ID }}",
      "access_type": "offline",
      "code_challenge_method": "{{ .extidp_details.cryptoProvider.details.hashAlg }}",
      "code_challenge": "{{ cryptoHashSum .context .code_verifier .extidp_details.cryptoProvider }}",
      "permissions": "{{ $perm := printf `[{\"sysname\":\"<ТИП_СОГЛАСИЯ>\",\"scopes\":[{\"sysname\":\"ndfl_person\"},{\"sysname\":\"payout_income\"}],\"purposes\":[{\"sysname\":\"<ЦЕЛЬ>\"}],\"actions\":[{\"sysname\":\"ALL_ACTIONS_TO_DATA\"}],\"responsibleObject\":\"<ФИО_ИЛИ_ПОДРАЗДЕЛЕНИЕ>\",\"expire\":<СРОК_В_МИНУТАХ>}]` }}{{ $perm | base64 }}"
    },
    "userInfoPipeline": [
      {
        "t": 1,
        "d": {
          "state": "{{ guid }}"
        }
      },
      {
        "t": 0,
        "r": "token",
        "m": "POST",
        "u": "{{.extidp_details.baseUrl}}/aas/oauth2/v3/te",
        "d": {
          "client_certificate_hash": "{{.extidp_details.clientCertHash}}",
          "client_id": "{{.extidp_details.clientID}}",
          "client_secret": "{{$ts := timeFormat \"2006.01.02 15:04:05 Z0700\" .process_started}}{{$clientSecretRaw := join .extidp_details.clientID .extidp_details.scope $ts .state .extidp_request.CallbackURI .code}}{{ cryptoSign .context $clientSecretRaw .extidp_details.cryptoProvider | base64 }}",
          "code": "{{.code}}",
          "grant_type": "authorization_code",
          "redirect_uri": "{{.extidp_request.CallbackURI}}",
          "scope": "{{.extidp_details.scope}}",
          "state": "{{.state}}",
          "timestamp": "{{timeFormat \"2006.01.02 15:04:05 Z0700\" .process_started}}",
          "token_type": "Bearer",
          "code_verifier": "{{ .code_verifier }}"
        }
      },
      {
        "t": 1,
        "d": {
          "verify_id_token": "{{ cryptoVerifyJWT .context .token.id_token .extidp_details.cryptoProvider }}"
        }
      },
      {
        "t": 2,
        "d": {
          "id_token_claims": "jwt(token.id_token)"
        }
      },
      {
        "t": 1,
        "d": {
          "is_trusted": "{{ with index .id_token_claims \"urn:esia:sbj\" \"urn:esia:sbj:is_tru\" }}{{ if not . }}{{ fail \"user is not trusted\" }}{{ end }}{{ end }}"
        }
      },
      {
        "t": 0,
        "r": "person",
        "m": "GET",
        "u": "{{.extidp_details.baseUrl}}/digital/api/public/v1/pso/{{printf \"%.0f\" .id_token_claims.sub}}",
        "h": {
          "Authorization": "Bearer {{.token.access_token}}"
        }
      },
      {
        "t": 1,
        "d": {
          "person_ok": "{{ with .person.oid }}{{ else }}{{ fail \"cp: pso response has no oid\" }}{{ end }}"
        }
      },
      {
        "t": 0,
        "r": "income_ref",
        "m": "GET",
        "u": "{{.extidp_details.baseUrl}}/digital/api/public/v1/pso/{{printf \"%.0f\" .id_token_claims.sub}}/doc/INCOME_REFERENCE",
        "h": {
          "Authorization": "Bearer {{.token.access_token}}"
        }
      },
      {
        "t": 0,
        "r": "payout_income",
        "m": "GET",
        "u": "{{.extidp_details.baseUrl}}/digital/api/public/v1/pso/{{printf \"%.0f\" .id_token_claims.sub}}/doc/PAYOUT_INCOME",
        "h": {
          "Authorization": "Bearer {{.token.access_token}}"
        }
      },
      {
        "t": 2,
        "d": {
          "income_status": "r = \"no\"; d = income_ref; if (Array.isArray(d)) { if (d.length && d[0].error) { r = \"error\"; } else if (d.length && d[0].status) { r = \"yes\"; } else if (d.length && d[0].requestId) { r = \"pending\"; } else if (d.length && d[0].statusDoc) { r = d[0].statusDoc; } } else if (d) { if (d.statusDoc) { r = d.statusDoc; } else if (d.requestId) { r = \"pending\"; } else if (d.error) { r = \"error\"; } else if (d.status) { r = \"yes\"; } } r;",
          "payout_income_status": "r = \"no\"; d = payout_income; if (Array.isArray(d)) { if (d.length && d[0].error) { r = \"error\"; } else if (d.length && d[0].status) { r = \"yes\"; } else if (d.length && d[0].requestId) { r = \"pending\"; } else if (d.length && d[0].statusDoc) { r = d[0].statusDoc; } } else if (d) { if (d.statusDoc) { r = d.statusDoc; } else if (d.requestId) { r = \"pending\"; } else if (d.error) { r = \"error\"; } else if (d.status) { r = \"yes\"; } } r;",
          "income_years": "r = \"\"; if (Array.isArray(income_ref)) { for (i = 0; i < income_ref.length; i++) { if (income_ref[i].year) { r += (r ? \",\" : \"\") + income_ref[i].year; } } } r;"
        }
      }
    ],
    "attrMapping": {
      "fn": "{{.person.firstName}}",
      "ln": "{{.person.lastName}}",
      "mn": "{{.person.middleName}}",
      "un": "",
      "e": "",
      "p": "",
      "l": "",
      "xid": "",
      "rid": "state",
      "x": {
        "income_years": "{{.income_years}}",
        "income_status": "{{.income_status}}",
        "payout_income_status": "{{.payout_income_status}}"
      }
    },
    "isActive": false
  }
]