Подключение к API без кода: 8 шагов

2024 Автор: John Day | [email protected]. Последнее изменение: 2024-01-30 11:49

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

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

Мы взяли с собой друга, чтобы сделать путешествие намного проще.

Встречайте Слэша

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

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

Шаг 1. Решите, какой API вам нужен

Какую информацию вы ищете или хотите изменить?

Вы пытаетесь получить все сообщения @ dougthepug в Instagram? Возможно, вы хотите автоматически твитнуть любого, кто следит за твиттером вашей собаки (потому что, хотя собаки не могут говорить, им есть что сказать, мы знаем, что Слэш точно знает).

Если вы уже знаете сайт или API, к которому пытаетесь подключиться, переходите непосредственно к шагу 2. Если вы пытаетесь найти данные, но не знаете, с чего начать, Google - ваш друг. Найдите "[интересующие вас материалы] API" и посмотрите, что появится. Вы можете быть удивлены, насколько много информации существует.

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

Шаг 2. Найдите документацию по API

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

Их можно найти в Google "Документация по API [Insert Company]" или "Разработчик [Insert Company]".

Результаты должны перенаправить вас на портал разработчика. Найдите ссылку с надписью «Документы», «Документация», «Справочник» или «Технический справочник».

В документации вам может потребоваться найти конкретный API, который вам нужен, поскольку иногда может быть много вариантов. Facebook, например, имеет отдельные API для маркетинга, рекламы, страниц и многого другого.

Если API, к которому вы хотите подключиться, малоизвестен (например, Slash), вам может потребоваться документация у разработчика. У них может быть PDF-файл, содержащий нужную вам информацию, или онлайн-документацию, которой нет на их веб-сайте.

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

Шаг 3. Найдите конечную точку

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

Первое, что нужно искать, - это подходящие конечные точки. Должна быть одна конечная точка, соответствующая каждому типу данных, которые вы хотите. Конечная точка может выглядеть так:

slashtheapidog.com/api/bones/{id}

или просто

/ кости

В документации должен быть список конечных точек. Они могут быть верхнего уровня в документации или в разделе, называемом «ссылка», «конечные точки» или «методы». Чтобы найти подходящую конечную точку, найдите имя, соответствующее искомым данным. Например, если вам нужен список всех дыр, которые выкопал Слэш, вероятно, наиболее подходящим будет / Hole. В любом случае у каждой конечной точки должно быть описание, помогающее объяснить, что она делает.

Из его документов, это конечные точки в API Slash, связанные с дырами:

ПОЛУЧИТЬ

ПОЛУЧИТЬ

ЗАПИСЬ

ПОСТАВИТЬ

ЗАПИСЬ

Шаг 4. Определите тип вашего запроса

Теперь, когда вы нашли нужную конечную точку, вам нужно определить тип запроса для ее отправки.

Есть 4 типа запросов:

ПОЛУЧАТЬ

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

ПОЧТА

Запрос POST - это то, как вы говорите API создать что-то новое. Это похоже на просьбу Слэша выкопать (создать) для вас новую яму.

ПОЛОЖИЛ

Запрос PUT - это то, как вы указываете API обновить что-то, что было создано ранее. Это похоже на просьбу Слэша копнуть глубже (обновить) яму, которую он вырыл.

УДАЛЯТЬ

Запрос DELETE - это то, как вы приказываете API удалить что-то, что было создано ранее. Это похоже на просьбу Слэша заделать (удалить) яму, которую он вырыл ранее.

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

Шаг 5: изучите параметры

Многие запросы требуют дополнительных параметров. Параметры - это детали вашего запроса. Например, если вы хотите, чтобы Слэш принес вам все шары красного цвета, вам нужно указать цвет. Если вы хотите, чтобы он сделал новую яму, вам нужно сказать ему, где ее поставить и на какую глубину копать.

В документации по API, на которую вы ссылаетесь, должен быть раздел под названием «Параметры» или «Параметры» для каждой конечной точки и типа запроса. Обратите внимание, какие параметры являются обязательными, а некоторые - необязательными. Если параметр отмечен как необязательный, в документации может быть приведен пример, который также используется по умолчанию.

Параметры API Slash могут выглядеть примерно так для получения мячей:

ПОЛУЧИТЬ

Шаг 6. Отформатируйте запрос

У нас есть вся необходимая информация, осталось только сделать запрос!

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

Парабола - если вы хотите подключаться и работать с данными без кода

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