Что такое API?

Аббревиатура API (по-русски обычно произносится [апи]) расшифровывается как Application Programming Interface — “программный интерфейс приложения”. API — это набор определений, протоколов и инструментов, которые используются для взаимодействия между различными программами, системами и компонентами. В общем смысле API представляет собой спецификацию функций, методов и структур данных, которые одна программная система предоставляет другой системе для обмена информацией и выполнения различных операций.

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

Какие бывают API

API — довольно общее понятие, вот несколько видов для примера:

• Библиотечный API: предоставляет набор инструментов, функций и классов для разработчиков в различных областях, таких как обработка изображений, базы данных, научные вычисления и веб-разработка.
• API оборудования (Hardware API): предназначен для взаимодействия с внешним оборудованием, таким как датчики, считыватели карт и принтеры. Hardware API обеспечивают стандартный способ передачи данных и команд между компонентами аппаратного и программного обеспечения.
• API операционной системы: предоставляет доступ к низкоуровневым и высокоуровневым функциям операционных систем — управлению файлами, процессами, устройствами ввода-вывода и оконным интерфейсом.
• Web API: позволяет взаимодействовать с веб-сервисом через интернет. Обычно они используют протоколы, такие как HTTP или HTTPS, и форматы передачи данных, такие как JSON или XML.

Зачастую, когда говорят о API, имеют в виду именно Web API. Далее речь пойдет именно о нем.

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

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

Типы интеграции корпоративных систем

Обмен файлами

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

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

Общие базы данных и обмен сообщениями

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

Web API

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

1. Безопасность: при использовании Web API легко обеспечить защиту данных и доступа к системам с помощью механизмов аутентификации, авторизации и шифрования.
2. Независимость систем: Web API позволяет интегрировать различные системы без прямого доступа к их внутренним данным и ресурсам. В этом случае системы могут работать независимо и изменяться без влияния на другие системы, разработка становится проще и быстрее.
3. Масштабируемость: Web API способна выдерживать большие объемы данных и запросов, а также динамически реагировать на изменения нагрузки. Такой гибкости сложно достичь при интеграции другими способами.
4. Легкость поддержки и сопровождения: Web API облегчает поддержку и обновление систем благодаря их модульной архитектуре, стандартам и документации.

Таким образом, интеграция через Web API обеспечивает гибкость, безопасность, простоту сопровождения, легкость интеграции и удобство использования — повышая эффективность и производительность бизнес-процессов. Некоторые способы интеграции корпоративных систем:

• обмен файлами,
• общие базы данных,
• обмен сообщениями,
• Web API.

Отзыв от “ВкусВилла” дает понять, как работает интеграция и какие дает преимущества на стороне пользователя решения “Кадровая лидогенерация”. Теперь постараемся разобраться, как устроен этот процесс изнутри.

Способы интеграции

Для быстрого и качественного закрытия потребностей заказчиков BetaOnline интегрирует свое программное обеспечение HRDrom с ATS системой партнера.
Программное обеспечение HRDrom может интегрироваться двумя способами:

• при помощи OpenAPI, который предоставляет программный комплекс HRDrom для интеграции со стороны информационной системы клиента;
• при помощи разработки интеграционного модуля для взаимодействия программного комплекса HRDrom с API информационной системы клиента.

HRDrom OpenAPI

Для обеспечения безопасного обмена данными между системами HRDrom OpenAPI предоставляет следующие функции:

• сброс пароля. Перед настройкой процесса обмена данными партнеру необходимо сбросить изначальный пароль и установить новый. Без этой операции остальной функционал API недоступен. Таким образом гарантируется конфиденциальность пароля. В HRDrom они хранятся в зашифрованном виде и не известны сотрудникам компании;
• аутентификация. Процесс получения токена по паре логин и пароль;
• обновление и отзыв токена. Токен имеет срок действия, по истечении срока действия необходимо заново провести процесс аутентификации. Если потребуется, токен может быть отозван до истечения срока действия;
• получение и обновление справочных данных: списка профессий, локаций;
• получение лидов и подтверждение получения;
• фиксация информации о продвижении лида по рекрутинговой воронке.

Интеграционный модуль HRDrom

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

• аутентификации/авторизации;
• метод для записи лида из базы данных HRDrom в информационную систему клиента;
• метод получения информации о продвижении лида по рекрутинговой воронке.

Проблемы интеграционного процесса и как их избежать

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

• Отсутствие информации о производительности API. Чтобы обеспечить непрерывный обмен данными, необходимо владеть информацией, сколько запросов за единицу времени API может обработать. В противном случае возможна ситуация, когда API не способен обработать входной поток данных или своевременно отдать необходимую информацию, — это неизбежно приведет к ухудшению результатов интеграции.

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

• Изменение контрактов на лету, пренебрежение версионированием. Изменение контракта API в процессе эксплуатации вызовет отказ интеграционного модуля, прервет процесс обмена данными и, соответственно, ухудшит результаты. Если возникает необходимость внести изменения в контракт API, необходимо использовать версионирование API — реализацию нового метода API с новым контрактом, но также поддержку старых методов. Такой подход позволит бесшовно перейти на использование новых методов API.

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

• Проведение технических работ без уведомления партнера — и в этом случае процесс обмена данными будет прерван. Нужно заранее предупредить о предстоящих работах, чтобы контролируемо остановить потоки данных.

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

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

Чек-лист: как провести интеграцию эффективно и без лишних сложностей

Итак, вы решили интегрировать свою ATS или CRM со сторонним ПО. На что следует обратить внимание вам, основному заказчику и пользователю:
1. Четко сформулировать задачу: что я хочу получать, что я готов отдавать.
Например:

• провести интеграцию с целью ускорить обработку данных в 2 раза → получить рост конверсии на 30%;
• отдавать статусы по данным в режиме реал-тайм → повысить качество данных с 1 до 5%.

2. Определить ресурсы проекта: определить продакт-менеджера или проджект-менеджера (в разных компаниях эти функции выполняют разные специалисты), который непосредственно ведет проект ATS/CRM в вашей компании. Если такого специалиста нет, нужно найти контакты на стороне подрядчика, который устанавливал действующее ПО для работы с персональными данными.

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

4. Проработать четкое ТЗ, согласованное с заинтересованными лицами. В BetaOnline мы предлагаем клиенту заполнить бриф, который закрывает все технические вопросы.

5. Запросить ссылку — документацию по API у ответственных лиц.

6. Определить бюджет проекта, если возможны затраты, а также сторону, на которую лягут эти затраты.

И в завершение — простой, но важный вопрос. Если вы не в ИТ-компании и не ИТ-специалист, нужно ли разбираться в том, как устроен процесс интеграции и как он работает?

Ответ, как часто бывает, дает сама реальность. Глобальный рынок API растет со среднегодовой скоростью 35%, в ближайшие два года этот сегмент будет занимать лидерские позиции. Уже сегодня сложно представить работу продвинутого маркетолога или HR-маркетолога без понимания процесса интеграции, ее ценностей и пользы для бизнеса в целом.

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