Что такое конечная точка API - разберем на примерах

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

API, сокращенно от Application Programming Interface, представляет собой набор правил, позволяющих приложению делиться своими данными с сторонними разработчиками. Проще говоря, API позволяет вам взять «их материал» и заставить его работать с «вашим материалом». В этом случае их содержимое находится в конечной точке API.

Что такое конечная точка API?

Конечная точка API — это цифровое место, где API получает запросы о конкретном ресурсе на своем сервере. В API конечная точка обычно является унифицированным указателем ресурса (URL), который обеспечивает расположение ресурса на сервере.

Чтобы полностью понять это определение и то, как конечные точки вписываются в модель API, давайте кратко рассмотрим, как работают API.

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

Получив и проверив запрос клиента, API выполняет запрошенное действие, а затем отправляет ответ обратно клиенту. Этот ответ включает статус запроса (например, завершен или отклонен) и любые ресурсы, запрошенные клиентом.

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

Зная это, как клиенты указывают, к какому ресурсу они хотят получить доступ в своем запросе?

Ответ заключается в использовании правильной конечной точки. В своих запросах клиенты указывают конечную точку в виде URL-адреса. Этот URL-адрес сообщает серверу: «Ресурс, который мне нужен, находится в этом месте».

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

Конечная точка и API

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

Примеры конечных точек API

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

Пример конечной точки API Twitter

API Twitter предоставляет данные о твитах, прямых сообщениях, пользователях и многом другом.

Допустим, вы хотите получить содержимое определенного твита. Для этого вы можете использовать конечную точку поиска твитов, которая имеет URL-адрес https:// api.twitter.com/2/tweets/{id} (где {id} — уникальный идентификатор твита).

Теперь предположим, что вы хотите, чтобы ваш веб-сайт транслировал общедоступные твиты в режиме реального времени, чтобы ваши посетители были в курсе определенной темы. Вы можете использовать конечную точку отфильтрованного потока Twitter, URL-адрес которой https:// api.twitter.com/2/tweets/search/stream.

Пример конечной точки API Spotify

API Spotify предоставляет разработчикам доступ к песням, исполнителям, плейлистам и пользовательским данным. Например, если вы хотите получить определенный альбом, вы можете получить доступ к любому альбому в каталоге Spotify с конечной точкой https:// api.spotify.com/v1/albums/{id} (где {id} — уникальный номер альбома). идентификатор).

Или, скажем, вы хотите отправить запрос, который заставляет пользователя следить за плейлистом. В этом случае отправьте запрос PUT с конечной точкой https:// api.spotify.com/v1/playlists/{playlist_id}/followers (где {playlist_id} — уникальный идентификатор плейлиста).

Пример конечной точки API YouTube

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

Другой способ получить видео через API YouTube — запросить их из конечной точки https:// www.googleapis.com/youtube/v3/videos, которая возвращает список видео, соответствующих параметрам, указанным в запросе.

Почему важны конечные точки API?

Один из первых вопросов, который вы задаете об API, звучит так: почему так много компаний открыто и бесплатно делятся своими данными?

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

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

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

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

Как тестировать конечные точки API

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

GET: извлекает ресурс
POST: создает ресурс
PUT: обновляет существующий ресурс
DEL: удаляет ресурс

Посмотрим, как сделать запрос с конечной точкой отфильтрованного потока API Twitter. Запросы форматируются путем написания метода HTTP, за которым следует URL-адрес конечной точки. Таким образом, запрос к конечной точке отфильтрованного потока будет выглядеть так: POST https:// api.twitter.com/2/tweets/search/stream.

Мы можем применить критерии фильтрации к конечной точке в виде правил. Чтобы построить эти правила, вы будете использовать набор операторов. В этом примере вы можете использовать два оператора Twitter API — from: и has:links — чтобы просматривать твиты только от определенных учетных записей, содержащих ссылки.

В своем запросе вы будете использовать HTTP-метод POST. В дополнение к упомянутому выше правилу в вашем запросе вы должны указать тип контента и авторизацию. Ниже тип контента определяется как «application/json», поэтому запрос отображается в формате данных jаvascript Object Notation (JSON).

Существует несколько онлайн-инструментов для тестирования конечной точки API. Здесь мы будем использовать c URL, инструмент командной строки, поддерживающий HTTP. Он может делать запросы, получать данные и отправлять данные, поэтому это отличный инструмент для тестирования API.

Будущее API в бизнесе

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

Совместное использование API применимо ко всем предприятиям: не только к тем, которые работают в Интернете, но и ко всем, у кого есть веб-инструмент или компонент их организации. Конечно, эта концепция вызовет препятствия для некоторых организаций, основная из которых заключается в том, чтобы все были в курсе того, как работают API.

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