Tiêu đề GetAnalyst - Интеграции - Шаблон задачи на Интеграционный REST API-метод.pdf ✅

Шаблон постановки задачи на интеграционный REST API-метод —-------------------------------------------—-------------------------------------------—-------------------------- Получение компаний по ИНН [GET /company/{inn}] Здесь ссылка на Jira-задачу в разработку. Оглавление Общее описание API-документация DaData Сценарий работы (Use Case) Техническая реализация метода Запрос Ответ Успешный ответ Требования к обработке ошибок Маппинг данных Логирование Общее описание Полная информация о проекте, для задачи в котором разработан шаблон: #GABank (Telegram-канал GetAnalyst). Это задача для разработки интеграционного API-метода на разработчика Backend в вашем проекте. Необходимо разработать метод поиска компаний по ИНН, который будет использоваться в приложениях банка, чтобы ускорять ввод реквизитов для клиентов. Допустимо, что может быть введено неполное значение ИНН (от 5 до 12 символов), в этом случае клиенты банка будут выбирать организацию из предложенного списка совпадений. Метод должен возвращать список компаний, ИНН которых совпадает с переданным на вход значением (начало ИНН или полностью). —-------------------------------------------—-------------------------------------------—-------------------------- GetAnalyst.ru Telegram YouTube Сообщество системных аналитиков GetAnalyst

Шаблон постановки задачи на интеграционный REST API-метод —-------------------------------------------—-------------------------------------------—-------------------------- 2.2. Во внешней системе DaData, если введено ровно 10 (юрлица) или 12 (инд. предприниматели) символов - вызов API-метода POST http://suggestions.dadata.ru/suggestions/api/4_1/rs/findById/party При тестировании API через Postman выявлено, что при частичном вводе ИНН от DaData возвращается пустой результат, поэтому в DaData поиск только по полному ИНН. Запрос во внешнюю систему DaData должен быть авторизован в соответствии с требованиями к авторизации, описанными в отдельной статье с описанием интеграции к DaData. 3. Полученные результаты объединяются. В приоритете выводятся все совпадающие компании из БД банка, а затем из DaData. Из ответа DaData для результата брать только те поля, которые описаны в маппинге данных. 4. Результат поиска возвращается в ответ на запрос клиента API #GABank. Альтернативные сценарии и обработка ошибок: 0А. Выполнить стандартные проверки для API-метода GABank: ● Запрос выполнен авторизованным пользователем GABank в одном из приложений системы. Метод доступен как клиентам, так и сотрудникам банка, по ролям пользователей ограничений нет. Иначе: Вернуть ошибку авторизации запроса HTTP-401 с текстом “Пользователь не авторизован”. 1А. Если передано невалидное значение, вернуть ошибку с текстом “Неверное значение. Ожидается от 5 до 12 цифр ИНН для поиска.”. 2.1А.Передано НЕ 10 и НЕ 12 символов и результаты не найдены в БД. Не переходить к шагу 2.2. Возвращать пустой результат: [] с HTTP-200. 2.2A. Выполнен запрос в DaData, но ожидание ответа превышает 5 сек. Прервать выполнение запроса. Продолжить работу только с теми результатами, которые были получены в результате п. 2.1. Иначе высокий риск сделать неудобный UX для пользователя и возвращать невалидные предложения для выбора организации по ИНН. 2.2B. При выполнении запроса в DaData получен пустой ответ. { "suggestions": [] —-------------------------------------------—-------------------------------------------—-------------------------- GetAnalyst.ru Telegram YouTube Сообщество системных аналитиков GetAnalyst
Шаблон постановки задачи на интеграционный REST API-метод —-------------------------------------------—-------------------------------------------—-------------------------- } или любой ответ с ошибкой, не соответствующий структуре с результатами поиска. Продолжить работу только с теми результатами, которые были получены в результате п. 2.1. 2.2C. При выполнении запроса получена ошибка авторизации в DaData. Записать ошибку в логи. Отправить предупреждение ответственным, если ошибка повторяется более 3 раз подряд для запросов разных или одного пользователя. Результат: Список найденных юрлиц по ИНН в составе данных: ● полное наименование, ● короткое наименование, ● ИНН, ● КПП, ● расчетные счета (если найдены во внутренней БД банка): ○ БИК ○ Банк ○ к/с ○ р/с В одном результате поиска по умолчанию возвращать до 50 записей, не настраивается. —-------------------------------------------—-------------------------------------------—-------------------------- GetAnalyst.ru Telegram YouTube Сообщество системных аналитиков GetAnalyst