API. Интеграция API в программы

Отмечается увеличение числа API, предлагаемых различными компаниями и разработчиками. Широкое использование API в различных сферах, таких как социальные сети, финансы, здравоохранение и т.д., делает их актуальными объектами исследования. Интеграция API позволяет объединять различные программы, сервисы и платформы, предоставляя удобный способ обмена данными. Это актуально для любой организации или проекта, который стремится автоматизировать задачи и оптимизировать процессы.

Что вы узнаете из данной статьи:

1. Определить что такое интерфейс прикладного программирования (API)
2. Определить виды API
3. Какие плюсы и преимущества имеет использование API в различных программах
4. Объяснение ключевых принципов проектирования API
5. Определить условия безопасности и конфиденциальности при использовании API
6. Рассмотреть примеры известных API и разработать проект с интегрированным в него API

Что же такое API?

API расшифровывается как "Application Programming Interface" (Интерфейс прикладного программирования). Это набор правил и механизмов, который позволяет различным программным приложениям взаимодействовать друг с другом. API определяет способы, в которые компоненты программного обеспечения могут взаимодействовать друг с другом, предоставляя определенные функции и возможности.

Так же в среде программирования есть не один вид интерфейсов прикладного программирования, вот некоторые из них:

• Веб-разработка: API позволяет разработчиком взаимодействовать с веб-серверами и использовать функциональные возможности различных онлайн-сервисов.
• Работа с базами данных: API облегчает доступ к базам данных и выполнение операций над данными.
• Разработка приложений: Многие платформы, такие как iOS и Android, предоставляют API для создания приложений, включая доступ к устройствам, сервисам и встроенным функциям
• Интеграция приложений: Различные приложения могут использовать API для обмена данными и интеграции с другими приложениями.

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

Так же в среде программирования есть не один вид интерфейсов прикладного программирования, вот некоторые из них:

• Веб-API - это набор протоколов и инструментов, которые позволяют взаимодействовать между различными веб-платформами, приложениями и сервисами. Веб-API обычно предоставляются в виде HTTP-ресурсов и используются для обмена данными между клиентской и серверной сторонами. Особенностью веб-API является то, что они обычно основаны на стандартах, таких как REST (Representational State Transfer(способ создания API с помощью протокола HTTP))или SOAP (Simple Object Access Protocol(обмен сообщениями между сервером и клиентом)), и могут быть доступны через публичные или защищенные точки входа. Веб-API используются для создания приложений, интеграции с внешними системами, получения данных и разработки новых сервисов.
• Библиотечные API - это набор функций и процедур, предоставляемых программной библиотекой для разработчиков. Библиотечные API позволяют использовать возможности библиотеки без необходимости писать все функции и структуры заново. Они являются интерфейсом между приложением и библиотекой, позволяя программистам вызывать функции, передавать параметры и получать результаты. Особенностью библиотечных API является то, что они обычно предоставляются в виде набора заголовочных файлов и библиотек, которые необходимо подключить к проекту. Библиотечные API позволяют повторно использовать код, упрощают разработку и ускоряют процесс создания приложений.
• Операционные системные API - это набор интерфейсов, предоставляемых операционной системой для взаимодействия с различными аппаратными и программными компонентами компьютера. Операционные системные API предоставляют доступ к функциям и ресурсам операционной системы, таким как файловая система, сеть, устройства ввода/вывода, процессы, потоки и т. д. Они используются программистами для разработки приложений, взаимодействия с операционной системой и управления системными ресурсами. Особенностью операционных системных API, как можно догадаться по названию вида, является их зависимость от конкретной операционной системы и аппаратной платформы. Различные операционные системы, такие как Windows, macOS и Linux, предоставляют свои собственные наборы системных API.

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

Использование API имеет свои преимущества над полной
разработкой собственной базы данных с нуля.

Это такие примеры как:
1. Более продуктивная работа: Использование API позволяет разделить задачи между различными программными компонентами. Когда приложения взаимодействуют через API, они обмениваются только необходимыми данными и функциями, что позволяет оптимизировать процесс обработки и ускорить выполнение задач. Более того, использование API позволяет необходимым образом реализовывать принципы асинхронной обработки данных, что позволяет улучшить отклик системы и обеспечить более высокую скорость работы. Также использование API различных сервисов вообще не имеет необходимости обращаться к создателям.
2. Снижение затрат: Разработка программного обеспечения с использованием API позволяет сделать систему более экономичной по ресурсам и снизить затраты на разработку. Вместо того, чтобы создавать все необходимые функции и компоненты самостоятельно, разработчик может использовать готовые API, предоставленные другими разработчиками или компаниями. Это позволяет значительно сократить время и затраты на разработку нового функционала, а также использовать уже проверенные и оптимизированные решения.
3. Возможность получения дохода: Первоисточник, который предоставляет данные в какой либо сфере, например, как прогноз погоды, получает доход при каждом новом запросе, когда их API является частью работы приложения. Создатель API сам выдвигает чек-лист стоимости.

Основные принципы проектирования API

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

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

Безопасность

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

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

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

• Статья 272.1 "Неправомерный доступ к компьютерной информации". Эта статья устанавливает ответственность за незаконное проникновение в информационную систему или получение доступа к компьютерной информации.
• Статья 183.2 "Мошенничество в сфере информационных технологий". Если украденное API использовано для обмана или получения незаконной выгоды от других лиц, это может рассматриваться как мошенничество.
• Статьи 146 или 147 Уголовного кодекса РФ, касающиеся нарушения авторских и смежных прав. Если украденное API содержит охраняемую авторским или иным правом информацию, то такое использование может быть признано нарушением и подпадать под указанные статьи.

Примеры API известных компаний:

• Facebook Graph API:

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

• Google Maps API:

Функционирование: Позволяет разработчикам интегрировать карты Google на свои веб-сайты и мобильные приложения. Предоставляет различные функции, такие как отображение местоположения, маршрутов, поиск и геокодирование.
Удобство: Разработчики могут создавать интерактивные карты, добавлять функциональность маршрутизации для показа наилучшего пути, интегрировать карты в свои приложения, добавлять на них метки и эффекты, а также адаптировать карты под нужды конкретного проекта.

• Twitter API:

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

• GitHub API:

Функционирование: Позволяет разработчикам взаимодействовать с репозиториями, пользователями и другими данными на Github. Предоставляет доступ к функционалу, такому как создание/удаление репозиториев, загрузка файлов, открытие задач и т.д.
Удобство: Разработчики могут создавать инструменты для управления репозиториями на Github, автоматизировать процессы создания или синхронизации кода, вести отчеты об активности или создавать уведомления о новых коммитах.

Тренды и инновации в области API

• Микросервисная архитектура: В последние годы микросервисная архитектура стала популярной в разработке программного обеспечения. Эта архитектура включает создание небольших и независимых сервисов, каждый со своим собственным API. Такая архитектура обеспечивает более гибкую и масштабируемую разработку, позволяет использовать различные технологии и языки программирования для каждого сервиса. В будущем API для микросервисов будет продолжать развиваться, чтобы упростить и сократить сложность взаимодействия различных сервисов.
• Использование RESTful API: REST (Representational State Transfer) - это архитектурный стиль для создания веб-сервисов. RESTful API позволяет взаимодействовать с веб-ресурсами с помощью стандартных HTTP-методов (например, GET, POST, PUT, DELETE). Этот подход становится все более популярным, так как он упрощает разработку, поддержку и интеграцию API. В будущем API будут продолжать развиваться в сторону большей совместимости и гибкости для удовлетворения разнообразных потребностей разработчиков и клиентов.
• Улучшенная безопасность и аутентификация: С ростом внимания к безопасности данных, API будут продолжать развиваться, чтобы обеспечить безопасное и защищенное взаимодействие. Это включает в себя улучшенные методы аутентификации и авторизации, такие как токены доступа, многофакторная аутентификация и блокировка повторных атак.
• Использование OpenAPI: OpenAPI (ранее известный как Swagger) - это спецификация, используемая для описания API. OpenAPI помогает разработчикам лучше понимать и использовать API путем автоматической генерации документации и клиентских SDK. Ожидается, что использование OpenAPI и Swagger будет продолжать расти в будущем, чтобы облегчить взаимодействие с API и улучшить процесс разработки и интеграции.

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

Создание проекта с интегрированным API

1. Получение API ключа:

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

Рисунок 1. Выбор нужного API

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

Рисунок 2. Тарифные планы на одну из категорий

Далее, для получения уникального API ключа, надо нажать на “Get API key” или “Subscribe”, в зависимости от выбора подписки пользователем. Далее проходим регистрацию, если нет аккаунта на OpenWeatherMap.

Рисунок 3, 4. Поиск своего API ключа

Рисунок 3, 4. Поиск своего API ключа

2. Интеграция API в код

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

1. Простота написания кода
2. Наличие встроенных библиотек
3. Возможность подключения дополнительных модулей
4. Возможность открытия программы на различных платформах

Для написания кода будет использоваться язык программирования Python, который удовлетворяет вышеперечисленным критериям, и его библиотеки: Tkinter и Pillow, для создания визуала программы показа погоды; requests, для выполнения HTTP- запросов; os, благодаря ему поведение программы не зависит от операционной системы; urlib.request, для открытия URL-адресов. Просмотрев аналоги программ, написанных с помощью библиотек Tkinter, Pillow, requests, urlib.request, os и изучив документацию библиотек, я приступил к написанию программного кода. Такие библиотеки, как Tkinter, Pillow, urlib.request, requests, необходимо скачивать. Это можно сделать через Python console в Pycharm, вписав в нее ~pip install tkinter, ~pip install pillow, ~pip install requests, ~pip install urllib3

3. Код программы

В начале написания кода необходимо произвести импорт необходимых модулей:

Рисунок 5. Импорт библиотек в Python

В этой части кода импортируются модули `tkinter` для создания оконного интерфейса, `requests` для отправки запросов к погодному API, `PIL` для работы с изображениями, `os` для работы с файловой системой и `urllib.request` для загрузки изображений по URL.

Рисунок 6. Создание окна приложения

В этой части кода создается окно приложения с помощью `tk.Tk()`. Устанавливаются размеры окна с помощью `HEIGHT` и `WIDTH`. Затем создается холст (`C`), который занимает всю площадь окна. Добавляется также фоновое изображение с помощью `background_image` и `background_label`.

Рисунок 7. Написание функций

Функция `format_response(weather_json)` форматирует полученный ответ от API в виде строки с информацией о погоде, такой как название города, описание погодных условий и температура. Результат форматируется с помощью функции `format_response(weather_json)` и отображается в виджете `results`.

Функция `get_weather(city)` отправляет запрос к API OpenWeatherMap с использованием указанного города и получает данные о погоде.

Функция `open_image(icon)` загружает и выводит иконку погоды, связанную с текущими погодными условиями.

Рисунок 8. Создание виджетов

В этой части кода создаются виджеты, такие как фрейм (`frame`), поле ввода (`textbox`), кнопка (`submit`), второй фрейм (`lower_frame`), метка (`results`) и холст (`weather_icon`).

Рисунок 9. Загрузка иконок погоды

В этом фрагменте кода загружаются иконки погоды с помощью `urllib.request.urlretrieve`. Иконки загружаются с того же сайта OpenWeatherMap в формате PNG и сохраняются в директории `./img/`.

В последней строке кода запускается основной цикл приложения `app.mainloop()`, который ожидает взаимодействия с пользователем и отображает окно приложения.

Первый запуск приложения

Рисунок 10. Внешний вид программы

Программа успешно работает, выводит погоду вне зависимости от того на каком языке вписано в поисковое окно название города, показывает какое дневное время в запрошенном городе.