
Если ваше приложение уже отправляет или принимает факсы через другого провайдера, переход на Fax.Plus начинается с анализа того, как это подключение работает сейчас. Факс-API — это соединение, через которое ваше программное обеспечение отправляет документы, получает входящие факсы и проверяет результаты. При замене API нужно убедиться, что все повседневные задачи по-прежнему выполняются как ожидается. Статья пошагово описывает переход: от доступа к учётной записи и обработки документов до тестирования и переноса факсовых номеров. Она также объясняет, что такое переключение — момент, когда приложение начинает использовать нового провайдера для реальной работы. Цель — дать разработчикам и операционной команде общий план, который можно протестировать до переключения.
Составьте краткий список, который могут вместе проверить разработчик и сотрудник, отвечающий за повседневную работу с факсами. Включите в него исходящие факсы, входящие номера, хранение документов, уведомления о доставке, а также любое бизнес-ПО, которое использует эти документы или уведомления. В описанных ниже шагах «задание» означает одну факсовую задачу, которую должно отслеживать ваше приложение.
Для каждого процесса зафиксируйте, что его запускает, откуда поступает документ, кто его получает и что происходит при сбое доставки. Выявите задания по расписанию, ручные повторные отправки и документы, которые сотрудник уже отправил, но приложение ещё не отметило как завершённые.
Разделите работу на три категории:
Продумайте экспорт и хранение архивных записей отдельно от переноса номера. Например, вашей команде может понадобиться найти отчёт о подтверждении факса, отправленного за несколько месяцев до перехода. Решите, где будет храниться такой отчёт, кто получит к нему доступ и как долго организация обязана его сохранять.
Затем согласуйте, что означает «готовность к переключению». Это критерии приёмки: проверки, которые необходимо пройти до начала использования новой интеграции для реальной работы. Например, документ должен читаться, входящий факс должен попадать в нужную команду, а результат доставки должен отображаться рядом с правильной записью в приложении. Выбирайте проверки, которые соответствуют вашим документам и адресатам.
Наш API доступен на тарифе Enterprise, как описано в кратком руководстве по API Fax.Plus. Прежде чем планировать перевод рабочей нагрузки на новую интеграцию, убедитесь, что учётная запись, назначенные номера и возможности соответствуют вашему рабочему процессу. Возможность переноса номера не равнозначна возможности использовать API.
Аутентификация — это способ, которым API определяет, к какой учётной записи может обращаться ваше приложение. Руководство по аутентификации описывает персональные токены доступа и OAuth 2.0. Персональный токен доступа — это секретный ключ, с помощью которого приложение подтверждает свои запросы. OAuth 2.0 позволяет пользователю разрешить доступ через вход в систему и подтверждение согласия. Разработчику следует выбрать метод, подходящий для вашего процесса, и выполнить требования к его настройке.
Храните учётные данные для реальной работы отдельно от тестовой среды, а секреты — на сервере, а не в коде, выполняемом в браузере. Ограничьте права только теми действиями, которые нужны приложению. Во время тестирования намеренно отключите тестовые учётные данные и проверьте, что приложение чётко сообщает о проблеме. При сбое подключения команда должна получить повод для расследования, а не повторные отправки.
Для регулируемых процессов до начала работы с реальными документами уточните требования вашей организации к безопасности и договорные требования. Одного технического подключения недостаточно, чтобы считать, что весь процесс соответствует этим требованиям, особенно если документы обрабатывают другие приложения.
Зафиксируйте, как данные текущей интеграции соответствуют данным новой. Такое соответствие иногда называют картой полей. Она должна охватывать такие сведения, как номер получателя, ссылка на документ, идентификатор факса и результат. Не меняйте собственный идентификатор задания в вашем приложении и сохраняйте рядом с ним идентификаторы старого и нового провайдеров.
Например, заказ PO-1042 в вашей системе должен остаться PO-1042 и после перехода. У его факса у нового провайдера может быть другой идентификатор отслеживания, но команда по-прежнему должна находить заказ, документ и результат отправки вместе.
В Fax.Plus сначала загружается файл. API возвращает путь — ссылку, которую приложение указывает в запросе на отправку. Конечная точка отправки — адрес API, принимающий этот запрос, — может возвращать идентификаторы запланированных факсов, если задать для значение . Сохраняйте эти идентификаторы, чтобы отслеживать дальнейший ход отправки.
Покажите в приложении различие между статусами «отправлено», «обрабатывается» и итоговым результатом доставки. Руководство по исходящим факсам описывает такие этапы, как конвертация документа и отправка. Успешный API-запрос означает лишь то, что запрос принят; приложение должно по-прежнему отслеживать факс до итогового результата.
Определите, что должна видеть ваша команда, если факс передан лишь частично, отправка завершилась ошибкой или результат требует внимания сотрудника. Полезное сообщение объясняет, что уже известно и что нужно проверить дальше. Это помогает оператору решить, нужно ли проверить документ, уточнить номер получателя или разрешить повторную попытку.
Проверьте внешний вид документов на тестовых файлах с вымышленными данными. Используйте многостраничные PDF, отсканированные страницы, мелкий текст и макет титульного листа, если он применяется в вашем процессе. Технически успешный запрос всё равно может привести к созданию документа, который получателю трудно прочитать.
Вебхук — это автоматическое сообщение, которое отправляется в ваше приложение при наступлении события, например при завершении передачи факса. Он позволяет приложению обновлять запись, не запрашивая постоянно, изменилось ли что-либо. Для новой интеграции следуйте актуальной документации по вебхукам и используйте .
Событие означает, что исходящий сеанс завершён, включая неудачные попытки. Прежде чем помечать запись как «доставлено», проверьте статус в сообщении. Проверьте подпись вебхука — криптографическую проверку, подтверждающую подлинность сообщения. Оперативно подтверждайте получение корректных сообщений. Более медленные операции, например обновление другой системы, выполняйте в фоновом режиме, чтобы ваш обработчик мог отвечать быстро.
Один и тот же вебхук может прийти более одного раза. Его заголовок — значение, передаваемое вместе с сообщением, — идентифицирует доставку и остаётся прежним при повторной отправке этого сообщения. Сохраняйте идентификаторы обработанных сообщений, чтобы повторное получение не приводило к повторному выполнению бизнес-действия. Этот приём называется дедупликацией.
Например, повторное получение одного и того же уведомления о доставке не должно приводить к двойному добавлению одного и того же вложения к заказу. Проверяйте это отдельно от защиты от повторной отправки факсов: проверка повторного обновления не показывает, нужно ли повторно отправлять запрос, результат которого неясен.
Начните с документов, не содержащих данных клиентов и конфиденциальной информации, и отправляйте их только на согласованные тестовые номера, которые контролирует ваша команда. Перед тестированием уточните настройки и возможные расходы. Если раньше вы использовали песочницу — изолированную среду для тестирования без обычной рабочей активности, — уточните, какой вариант тестирования доступен здесь, и не исходите из того, что он работает так же.
| Проверка | Что проверить перед запуском |
|---|---|
| Доступ к учётной записи | Приложение выполняет свои задачи. Недействительные или отключённые учётные данные приводят к понятной ошибке. |
| Подготовка документов | Типовые файлы при получении остаются читаемыми, полными и расположенными в ожидаемом порядке. |
| Успешная отправка | Документ доходит до получателя, а итоговый результат сохраняется рядом с нужной бизнес-записью. |
| Сбой и частичная доставка | Приложение сохраняет достаточно информации для проверки и не помечает задание как доставленное преждевременно. |
| Повторный вебхук | Повторное получение одного и того же обновления не создаёт дублирующее вложение или уведомление. |
| Прерванные обновления | Если приложение временно не может получать обновления, ваша команда может проверить запись о факсе и восстановить работу, не гадая, нужно ли отправлять факс повторно. |
| Входящий факс | Факс, отправленный на каждый тестовый номер, попадает в нужное место в приложении и к нужной команде. |
| Повторная попытка отправки | Ваша команда знает, какие повторные попытки выполняет провайдер, а какие требуют решения приложения или оператора. |
| Сохранённые подтверждения | Ваша команда может получить запись о факсе и необходимый отчёт из исходной бизнес-задачи. |
| Репетиция переключения | Ваша команда может определить незавершённые задания, при необходимости приостановить новые отправки и выполнить план восстановления. |
Сохраняйте результат каждой проверки: тип документа, контролируемый адресат, ожидаемое и фактическое поведение, нерешённая проблема. Устраняйте несоответствия критериям приёмки, прежде чем расширять охват.
Если вашему процессу нужен документ-подтверждение, Fax.Plus предоставляет конечную точку для PDF-отчёта о подтверждении. Проверьте, какой отчёт получает ваше приложение и как он хранится. Результат передачи не доказывает, что сотрудник просмотрел или принял документ.
Перенос номера передаёт действующий номер от одного провайдера другому, чтобы с вами по-прежнему могли связываться по нему. Если хотите сохранить свои номера, сначала проверьте, можно ли их перенести. Следуйте актуальному порядку переноса номеров в Fax.Plus, включая необходимые данные учётной записи и документы об авторизации.
Не отключайте действующую линию, пока Fax.Plus не подтвердит завершение переноса. Отмена до этого момента может сорвать перенос и поставить номер под угрозу.
Процесс переноса номера предусматривает временный номер: с ним можно начать работать с факсами, пока перенос не завершён. Используйте его, чтобы проверить процесс приёма факсов до переноса. Уточните, какой номер будет заменён, особенно если в учётной записи несколько номеров. После завершения переноса убедитесь, что входящие факсы снова поступают по нужному адресу.
Планируйте изменения в приложении и перенос номера одновременно, но отслеживайте их по отдельности. Работающая интеграция с API не означает, что номер уже перенесён. Точно так же завершённый перенос не доказывает, что приём факсов в вашем приложении и правила маршрутизации настроены правильно.
Прежде чем назначать дату переключения, подтвердите условия переноса номеров и договоритесь, как действовать при неудачной проверке. Разработчики иногда называют возврат к прежней конфигурации откатом. Однако если вернуть настройку в приложении, перенесённый номер сам не вернётся к прежнему провайдеру. Планируйте восстановление для программного обеспечения и для номеров отдельно.
Когда вы начнёте направлять рабочие задачи через Fax.Plus, чётко разграничьте задания, отправленные старому провайдеру, и задания, отправленные новому. Не отправляйте один и тот же рабочий документ через обоих провайдеров только ради сравнения результатов.
В момент переключения составьте список незавершённых отправок, запланированных заданий, нерешённых сбоев и входящих документов, которые ещё нужно обработать. Сверьте этот список с записями обоих провайдеров. Такая сверка помогает выявить задачи, которые иначе могут быть пропущены или выполнены дважды. Если результат отправки неясен, проверьте её запись, прежде чем повторять попытку через другого провайдера.
Проверьте первые рабочие операции по критериям приёмки. Отслеживайте признаки, значимые для работы: необработанные входящие документы, отсутствие итоговых статусов, нечитаемые страницы, повторные действия и расхождения между данными вашего приложения и записями провайдера.
Когда проверки будут пройдены, учтите все незавершённые задачи, сохраните нужные записи и убедитесь, что все переносы номеров завершены. Затем закройте старый сервис в соответствии с согласованным планом. Отключите неиспользуемые учётные данные и удалите прежние адреса вебхуков, чтобы они не оставались активными без необходимости.
Начните с одного рабочего процесса, который хорошо знает ваша команда. Перечислите, что он должен выполнять, согласуйте проверки, которые подтвердят его работоспособность, и используйте краткое руководство по API Fax.Plus для реализации.
Если вы ещё выбираете решение, на странице API Fax.Plus описаны сервис и способы связаться с нами. Подготовьте к обсуждению описание вашего рабочего процесса, ожидаемый объём использования и требования к номерам, чтобы спланировать переход с учётом реальных потребностей команды.
Как правило, проверить нужно не только адрес подключения. Сравните, как API обрабатывают доступ к учётной записи, загрузку документов, идентификаторы отслеживания, результаты и автоматические уведомления. После этого разработчик определит, какие изменения нужны вашему приложению, и протестирует их.
Нет. Рассматривайте ответ на запрос как этап передачи факса в обработку. Отслеживайте факс до итогового результата, а если процессу нужно подтверждение, используйте соответствующую запись или отчёт о подтверждении.
Начните с вымышленных документов и тестовых номеров, которые контролирует ваша команда. Используйте реальные документы только после проверки необходимых требований к безопасности, доступу, договорным условиям и работе процессов.
Прежде чем переключаться, проверьте возможность переноса номера. Не отключайте действующий сервис, пока перенос не подтверждён как завершённый, и протестируйте маршрутизацию входящих факсов после переноса номера.
Не обязательно. Если отделить бизнес-логику от обработки запросов и событий, специфичной для конкретного провайдера, объём изменений можно сократить. Фактический объём работ зависит от вашей текущей интеграции и от того, на какое поведение она опирается.
