Коды ошибок в проекте

Коды ошибок и статусы

Пример кода статуса в заголовке curl

Коды статусов не отображаются в тебе ответа. Они содержатся в хэдере, который может быть не видим по умолчанию.

Заголовок ответа выглядит следующим образом:

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

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

Можно посмотреть список общих кодов состояния REST API здесь и общий список кодов HTTP статусов здесь. Хотя, возможно, было бы полезно включить несколько стандартных кодов состояния, нет необходимости в полном документировании всех стандартных кодов состояния, особенно если они редко запускаются в API.

Где перечислять HTTP-ответ и коды ошибок

Практичнее, если API будут иметь одну страницу с ответами и кодами ошибок ко всему API. Отдельная страница с перечнем кодов состояния (вместо добавления кода состояния в каждую конечную точку) позволяет более детально описать каждый код без переполнения других частей документации. Такой подход уменьшает избыточность и ощущение информационной перегрузки.

С другой стороны, если какие-то коды состояния и ошибок больше подходят к определенным конечным точкам, чем другие, имеет смысл вывести такие коды состояния и ошибок на страницы с описаниями конечных точек.

Такая стратегия может заключаться в том, чтобы привлечь внимание к каким-либо особенно важным кодам состояния или ошибок для конкретной конечной точки, а затем перейти к централизованной странице «Коды ответов и состояний» для получения полной информации.

Где взять коды ошибок и статусы

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

В результате может потребоваться танцы с бубнами, чтобы найти все коды. В частности, возможно придется сломать API, чтобы увидеть все возможные коды ошибок. Например, если превысить ограничение скорости для определенного запроса, API может вернуть специальную ошибку или код состояния. Такой пользовательский код обязательно нужно задокументировать. В разделе устранения неполадок в API можно специально разместить примеры получения кодов ошибок.

Как перечислять коды ошибок

Коды статусов и ошибок можно привести в виде списка определений или таблицы, например так:

Коды состояния и ошибок помогают в устранении неполадок

Коды состояния и ошибок особенно полезны при устранения неполадок. Таким образом, можно рассматривать коды ошибок как дополнение к разделу по устранению неполадок.

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

В разделе по устранению неполадок можно перечислить сообщения об ошибках, связанных со следующими ситуациями:

текст ошибки должен точно документироваться, чтобы она легко появлялась при поиске.

Примеры кодов статусов и ошибок

Ниже приведены несколько вариантов разделов с кодами статусов и ошибок.

Context. io

Clearbit не только документирует стандартные коды состояния, но также описывает уникальные параметры, возвращаемые их API. Большинство разработчиков, вероятно, знакомы с кодами 200, 400 и 500, поэтому эти коды не требуют много пояснений. Но если API имеет уникальные коды, описывать их нужно адекватно и подробно.

Twitter

В Twitter не только описывается код и состояние, но также предоставляется полезная информация по устранению неполадок, потенциально помогая в устранении ошибок. Например, про ошибку 500 не просто сказано, что статус относится к неработающей службе, но и есть объяснение: «Обычно это временная ошибка, например, в ситуации высокой нагрузки или если у конечной точки временно возникают проблемы. Посетите форумы разработчиков на случай, если у других возникнут аналогичные проблемы, или повторите попытку позже».

Mailchimp

Mailchimp предоставляет удобочитаемые и понятные описания сообщений об ошибке. Например, в ошибке 403 вместо того, чтобы просто написать «Запрещено», Mailchimp объясняет причины, по которым можно получить ошибку запрещенного кода. У Mailchimp существует несколько типов ошибок 403. Запрос может быть запрещен из-за отключенной учетной записи пользователя или запроса, направленного не в тот центр обработки данных. В случае ошибки «WrongDataCenter» Mailchimp отмечает, что «она часто связана с неправильно настроенными библиотеками» и ссылается на дополнительную информацию о центрах обработки данных. Такой тип документации кода ошибки очень полезен для пользователей.

Flickr

В Flickr раздел «Коды ответов» встроен в описание каждой адресной темы API. Описания ошибок выглядят короткими. Хотя встраивание кодов ответов в каждую тему делает коды ошибок более заметными, в некоторых случаях такой подход менее полезен. Поскольку он встроен в каждую тему API, описания кодов ошибок должны быть краткими, иначе их содержимое будет перегружено информацией о запросе конечной точки.

Напротив, отдельная страница с перечнем кодов ошибок позволяет более подробно раскрывать каждый код, не вытесняя другую документацию. Отдельная страница также уменьшает избыточность и увеличивает объем информации.

?‍? Практическое занятие: Коды статусов и ошибок

В своем найденном опен-сорс проекте найдем информацию о кодах статусов и ошибок. Ответим на следующие вопросы:

Ошибка 99 в Сбербанк Бизнес как исправить проблему

Приложение Сбербанк Бизнес Онлайн, несмотря на свою функциональность и защищенность, может иногда выдавать ошибки. Это свойственно ему, как и любому другому приложению. Одна из них – ошибка 99, может возникнуть в самый непредвиденный момент. Что она означает и как ее исправить, читайте в этой статье.

Что это за ошибка

Ошибка 99 в Сбербанк Бизнес Онлайн возникает по вине пользователя. Из-за нее становится невозможно проводить транзакции. Она относится к сбою TLS-соединения и исправить ее могут только соответствующие специалисты из штата банка. Обычно эта проблема связана с нарушением контакта в платёжном оборудовании (терминале). Нужно проверить интернет-соединение и связь с банком, если это не помогло, вызвать на помощь специалистов. Им нужно сообщить о поломке платежного терминала.

Причины возникновения ошибки

Причин ошибки 99 может быть несколько, а именно:

отсутствие контактов в разъеме;

загрязнение или окисление контактов;

конфликтная работа с остальными устройствами;

Не рекомендуется самостоятельно исправлять ошибку, если она связана с поломкой платежного терминала. Крутить провода здесь точно не надо, это ни к чему не приведет. При возникновении ошибки в терминале, сразу позвоните техническому специалисту Сбербанка. Он определит причину сбоя и приступит к починке программного обеспечения. Если вы не знаете, где найти этого специалиста, то просто обратитесь в то отделение Сбербанка, которое устанавливало вам данный терминал для оплаты.

Как решить проблему

Чтобы исправить ошибку 99, нужно сделать следующее:

проверить состояние сетевой карты, роутера или свича;

при необходимости перезагрузите оборудование;

проверьте его на наличие обновлений;

узнайте, не проводятся ли на сайте Сбербанка технические работы;

проверьте, не находится ли сайт в черном списке антивируса.

Эта ошибка может возникать не только при работе с платежным оборудованием, но и при проведении платежей на сайте банка или в Сбербанке Бизнес Онлайн. В некоторых случаях может помочь переустановка программного обеспечения. Также сбои в оборудовании могут происходить из-за скопления в нем грязи и пыли. Если ошибка связана с некорректным подключением денежного ящика, то устранить ее можно только после проверки интернет-соединения. Переподключите устройство к другому порту, но перед этим получите консультацию представителя банка.

Особое внимание нужно уделить именно кабелям, так как из-за их поломки часто случаются сбои. Старые кабели лучше заменить на новые провода. Каждые 6 месяцев приносите платежный терминал в сервисный центр, чтобы ему провели плановый технический осмотр и произвели чистку. Если вы заметили на терминале другие коды ошибок, то перезагрузите его и отнесите к специалистам.

Всех нанимателей обязали с 2020 года передавать сведения о трудовой деятельности своих сотрудников в информационные ресурсы ПФР (ч. 1 ст. 66.1 ТК РФ). Данные подаются по форме СЗВ-ТД, утвержденной Постановлением Правления ПФР от 25.12.2019 № 730п. В числе передаваемой информации — сведения о сотруднике, месте работы, трудовой функции, датах приема и увольнения, переводах и других кадровых перестановках.

Сроки сдачи отчета четко регламентированы (пп. 2 п. 2.5 ст. 11 Закона от 01.04.1996 № 27-ФЗ). О трудоустройстве или увольнении сотрудника сообщить нужно не позже рабочего дня, следующего за днем издания приказа. По другим кадровым мероприятиям бланк сдается раз в месяц — до 15-го числа месяца, следующего за отчетным.

Ошибки при заполнении отчета СЗВ-ТД

Правила исправления ошибок в СЗВ-ТД, а также коды ошибок, выявляемых системой ПФР, определены Постановлением Правления ПФ РФ от 25.12.2019 № 730п.

После отправки СЗВ-ТД и получения от ПФР протокола работодателю нужно просмотреть, положительный он или отрицательный, и какой код ошибки зафиксировала система. Ошибки могут быть трех типов: предупреждения, негрубые ошибки и грубые ошибки.

Коды 20 означают, что отчет принят, но нанимателю нужно перепроверить сведения и в случае необходимости откорректировать их.

Коды 30 означают, что сведения приняты частично и требуют корректировки или дополнения.

Согласно пункту 38 инструкции, утвержденной Приказом Минтруда РФ от 22.04.2020 № 211н, при выявлении фондом ошибок в сведениях, поданных страхователем, последнему направляется уведомление об их устранении. На корректировку данных отводится пять рабочих дней.

Коды 50 означают, что отчет не принят и его нужно сдать заново.

Процедура исправления ошибки в СЗВ-ТД зависит от того, принял ПФР отчет или нет. Если пришел положительный протокол, но имеется ошибка, следует отменить запись с ошибочными данными. Для этого подается еще одна форма СЗВ-ТД, заполненная так же, как изначально, но напротив ошибочных сведений в графе «Признак отмены записи сведений о приеме, переводе, увольнении» проставляется знак «X». В следующей строке указываются исправленные сведения (п. 2.6, 2.7 приложения 2 к постановлению № 730п).

Если фонд отчет не принял, то есть получен отрицательный протокол, нужно заново заполнить бланк и отразить в нем только достоверные сведения.

Найти недочеты в отчете может как фонд, так и работодатель. Если ошибку нашел работодатель, он вправе исправить ее самостоятельно до того, как неточность обнаружит фонд (п. 40 инструкции, утвержденной Приказом Минтруда РФ от 22.04.2020 № 211н).

Отчет СЗВ-ТД: код ошибки 20

Расшифровка кодов 20 приведена в приложениях к постановлению № 730п. Получение из ПФР протокола с кодом ошибки 20 свидетельствует о следующих некритичных недочетах:

Ошибка 30 в отчете СЗВ-ТД

Согласно приложениям к постановлению № 730п, если программа ПФР выдает ошибку 30, это означает:

Ошибка в отчете СЗВ-ТД: код 50

Исправление ошибки с кодом 50 невозможно. Если ошибки при отправке СЗВ-ТД обозначены кодом 50, отчет не принят. Его нужно сформировать заново, исключив причину отказа в приеме. Как проверить расшифровку кода отказа в приеме отчета, говорится в приложениях к постановлению № 730-п.

Грубыми ошибками, совершенными при сдаче СЗВ-ТД, считаются:

Что делать, если отчет СЗВ-ТД сдан с ошибками

Если СЗВ-ТД сдана, ПФР ее принял, но впоследствии страхователь обнаружил недочеты в отчете, исправление ошибок допускается.

Так, согласно пункту 40 инструкции, утвержденной Приказом Минтруда РФ от 22.04.2020 № 211н, страхователь вправе исправлять ошибки в ранее поданных и принятых фондом сведениях до момента их выявления ПФР. При таких обстоятельствах платить штраф не придется.

Корректировка сведения в СЗВ-ТД осуществляется по правилам, приведенным в п. 2.6, 2.7 приложения 2 к постановлению № 730п. Сдается еще один бланк с указанием ошибочных данных и пометкой в признаке отмены, а ниже указываются корректные сведения.