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

Зачем вам нужны API?

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

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

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

Какие API существуют?

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

1. ОТДЫХ API: REST API — это тип веб-API, который использует методы HTTP (такие как GET, POST, PUT и DELETE) для получения и обработки данных. Они спроектированы так, чтобы быть легкими и гибкими и часто используются для создания веб-приложений и мобильных приложений.
2. Мыло API: API-интерфейсы SOAP (простой протокол доступа к объектам) — это типы веб-API, которые используют XML (расширяемый язык разметки) для кодирования данных и их передачи через HTTP. API-интерфейсы SOAP более стандартизированы и структурированы, чем API-интерфейсы REST, и часто используются в корпоративных средах, где важны безопасность и надежность.
3. ГрафQL API: GraphQL — это язык запросов API, который позволяет разработчикам запрашивать определенные данные из API вместо получения фиксированного набора данных. API-интерфейсы GraphQL являются гибкими и позволяют разработчикам запрашивать только те данные, которые им нужны, что может повысить производительность и сократить потери данных.
4. Веб-препятствия: Веб-перехватчики — это тип технологии API, которая позволяет серверу отправлять данные клиенту в режиме реального времени вместо того, чтобы клиент запрашивал данные у сервера. Они часто используются для обеспечения связи между приложениями в реальном времени и для запуска действий при возникновении определенных событий.
5. Облачный API: Облачные API позволяют разработчикам получать доступ к облачным сервисам, таким как хранилище, базы данных и аналитика, и взаимодействовать с ними. Эти API-интерфейсы могут помочь разработчикам более эффективно и результативно создавать и развертывать приложения.
6. Аппаратный API: Аппаратные API позволяют разработчикам получать доступ к аппаратным устройствам, таким как датчики, камеры и принтеры, и управлять ими. Эти API могут создавать приложения, которые взаимодействуют с физическими устройствами и управляют ими.

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

Исследуйте вопросы о возможностях их API:

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

Общий обзор

1. Какова основная цель вашего API и как он вписывается в общую стратегию вашей компании?
2. Какие типы API вы предлагаете (REST, SOAP, GraphQL и т. д.)?
3. Предлагает ли ваш API какие-либо уникальные функции, которых нет у конкурентов?

Анализ пробелов в функциях

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

Управление версиями и обновлениями

7. Как вы относитесь к управлению версиями API?
8. Как клиенты уведомляются об устаревании или серьезных изменениях версий API?
9. Существуют ли обратно совместимые обновления или новые версии требуют изменений кода на стороне клиента?
10. Поддерживаете ли вы несколько версий одновременно? Если да, то как долго?

Масштабируемость и производительность

11. Сколько вызовов API выполняется на ваши серверы каждый день?
12. Предназначен ли API для пула серверов или он разделяет ресурсы с другими службами?
13. Как масштабироваться по мере роста спроса? Ожидаете ли вы внезапных всплесков трафика?

Документация и поддержка

14. Можем ли мы получить доступ к документации API? Как часто он обновляется?
15. Предоставляет ли документация подробное объяснение каждой функции и переменной?
16. Есть ли примеры кода, SDK или библиотеки для разных языков и фреймворков?
17. Какие каналы поддержки доступны для решения проблем с API? (например, чат, электронная почта, специальный менеджер по работе с клиентами)

Сообщество разработчиков и ресурсы

18. Есть ли у вас онлайн-сообщество разработчиков, где можно делиться кодом, передовыми практиками и опытом интеграции?
19. Существуют ли форумы разработчиков, часто задаваемые вопросы или базы знаний специально для пользователей API?
20. Есть ли у вас специальные ресурсы по интеграции или внутренние консультанты, доступные для клиентов?
21. Можете ли вы предоставить ссылки или контакты компаний, которые успешно интегрировались с вашим API?

Совместимость интеграции

22. Какие форматы данных поддерживает API (например, JSON, XML и т. д.)?
23. Какие платформы, приложения и языки программирования успешно интегрировались с вашим API?
24. Имеется ли производственная интеграция со сторонними (3P) инструментами?
25. Предлагаете ли вы библиотеку примеров кода для ускорения интеграции?
26. Могу ли я получить доступ к песочнице или непроизводственной среде для тестирования?

Ограничения и тарифные ограничения

27. Какие ограничения скорости API применяются (например, количество вызовов в секунду, минуту, час)?
28. Существуют ли различные ограничения скорости в зависимости от типа доступных данных?
29. Можно ли обсуждать ограничения тарифов в зависимости от уровня использования или планов подписки?

Безопасность и соответствие требованиям

30. Как ваш API аутентифицирует пользователей? (например, ключи API, OAuth, токены и т. д.)
31. Есть ли варианты ограничить доступ к API по IP-адресу или местоположению?
32. Какие стандарты шифрования вы соблюдаете для данных при передаче и хранении?
33. Существуют ли определенные нормативные сертификаты, которым соответствует API, например GDPR, HIPAA или PCI-DSS?
34. Какие меры конфиденциальности данных принимаются для обеспечения соблюдения международных правил?

10. Надежность и время безотказной работы

35. Каково среднее время безотказной работы вашего API?
36. Предлагаете ли вы общедоступную панель мониторинга работоспособности?
37. Какова частота ошибок и как она отслеживается?
38. Установлены ли у вас фиксированные часы технического обслуживания и как уведомляются клиенты?
39. Существуют ли механизмы автоматического повтора попыток в случае простоя или прерывания?

Соглашения об уровне обслуживания (SLA)

40. Предлагаете ли вы соглашение об уровне обслуживания для своего API и каково гарантированное время безотказной работы?
41. Каково ваше типичное время ответа на проблемы с API в соответствии с соглашением об уровне обслуживания?
42. Существуют ли какие-либо финансовые или сервисные кредиты за нарушения SLA?

Путеводитель в будущее

43. Можете ли вы поделиться планами будущих функций и обновлений API?
44. Как часто выходят новые версии или крупные обновления?
45. Привлекаете ли вы клиентов к бета-тестированию новых функций или к сеансам обратной связи?

Мониторинг и протоколирование

46. Предоставляете ли вы инструменты регистрации или мониторинга активности API?
47. Могут ли клиенты получить доступ к статистике использования, чтобы отслеживать объем вызовов, частоту ошибок и производительность?
48. Есть ли встроенные инструменты для отслеживания активности пользователей и обнаружения аномалий?

Структура выставления счетов и ценообразования

49. Какова модель ценообразования для доступа к API (например, оплата за вызов, многоуровневая подписка)?
50. Взимается ли дополнительная плата за более высокие уровни использования или премиум-функции?
51. Могут ли цены корректироваться в зависимости от объема или конкретных случаев использования?

Процесс интеграции и адаптации

52. Каков типичный процесс адаптации новых пользователей API?
53. Предлагаете ли вы какие-либо консультационные услуги по первоначальной настройке и интеграции?
54. Сколько времени обычно занимает завершение интеграции и какие ресурсы требуются?

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

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

Помимо API, вам также следует попытаться выяснить, какие еще ресурсы интеграции у них могут быть: штрих-коды, картографирование, службы очистки данных, RSS, веб-формы, виджеты, формальные партнерские интеграции, программы сценариев, дампы SFTP и т. д.