Как отправить запрос к API с использованием ключа доступа? Узнайте, как добавить ваш API-ключ в заголовок запроса и получать данные от сервиса в своем приложении или сайте.
HTTP-запросы с использованием API-ключей — это один из наиболее распространенных способов взаимодействия с веб-серверами, которые предоставляют доступ к интересующим нас данным или функционалу. API-ключ обычно выдается каждому разработчику отдельно, и его использование позволяет идентифицировать клиента и разграничить доступ к информации.
Ниже мы рассмотрим, как выполнить HTTP-запрос с использованием API-ключа. Для этого вам необходимо будет знать, как работать с протоколом HTTP и использовать форматы данных JSON или XML для обмена данными с сервером.
Важно отметить, что каждый API-сервер может иметь свои правила и требования для выполнения запросов, поэтому необходимо ознакомиться с соответствующей документацией перед началом работы с API.
Как добавить api key для http запроса
API key — уникальный идентификатор, присвоенный вам при регистрации в API сервисе. Встраивание API key в запросы позволит сервису идентифицировать пользователя и контролировать его доступность к методам API.
Чтобы добавить API key в http запрос, необходимо создать заголовок в запросе:
- Задайте «X-Api-Key» в качестве ключа заголовка.
- Укажите API key в качестве значения заголовка. Например, X-Api-Key: your_api_key.
Помните, что без добавления API key в запросы, многие методы API не будут доступны пользователям. Также не забывайте о обеспечении безопасности своего API key, не передавайте его третьим лицам и храните его в надежном месте.
Источник: slavshkola.ru
Руководство разработчика по API
Документ предназначен для разработчиков, которые хотят добавить возможность поиска и использования словесных ассоциаций на свои сайты или в приложения.
- Общие сведения
- JSON-интерфейс
- XML-интерфейс
- Коды ответов
- HTTP заголовки ответа
Общие сведения
Для доступа к методам API необходимо получить API-ключ, подписашись на один из доступных тарифных планов. Для того чтобы подписаться на выбранный тарифный план, а также для управления существующими подписками, пожалуйста, войдите в вашу Учётную запись API Сервиса Словесных Ассоциаций.
Для доступа к API сервиса словесных ассоциаций по HTTPS вы можете использовать:
- JSON-интерфейс (ответ возвращается в формате JSON).
- XML-интерфейс (ответ возвращается в виде XML-документа).
Все интерфейсы имеют одинаковую функциональность и используют одни и те же входные параметры.
JSON-интерфейс
Ответ возвращается в формате JSON.
Поддерживаются методы GET и POST.
Синтаксис запроса
https://api.wordassociations.net/associations/v1.0/json/search? apikey= lang= [limit=] [indent=]
Слово или фраза, для которой необходимо найти ассоциации.
В запросе можно использовать несколько параметров text (от 1 до 10 включительно). Таким образом, в одном ответе можно получать ассоциации для нескольких входных слов или фраз.
- Для POST-запросов максимальный размер передаваемого текста составляет 10 000 символов.
- В GET-запросах ограничивается не размер передаваемого текста, а размер всей строки запроса, которая кроме текста может содержать и другие параметры. Максимальный размер строки — от 2 до 10 КБ (зависит от версии используемого браузера).
Размер входного текста неограничен. Однако подбор ассоциаций осуществляется лишь по первым 10 словам этого текста.
Задаётся в виде кода соответствующего языка.
- en — английский;
- es — испанский;
- it — итальянский;
- de — немецкий;
- pt — португальский;
- ru — русский;
- fr — французский;
Тип возвращаемого результата.
- stimulus — входными данными (параметр text ) является слово-ответ. Сервис возвращает список слов-стимулов, которые чаще всего побуждают подумать о заданном слове-ответе;
- response — входными данными (параметр text ) является слово-стимул. Сервис возвращает список ассоциативных слов-ответов, которые приходят на ум для заданного слова-стимула.
Значение по умолчанию:
Максимальное количество результатов.
Позволяет ограничить количество результатов (ассоциаций) в ответе. Параметр может принимать значение от 1 до 300.
Значение по умолчанию:
Искомые части речи.
Позволяет ограничивать результаты определёнными частями речи. Задаётся перечислением кодов частей речи, разделённых запятой.
Поддерживаются следующие коды:
- noun — имя существительное;
- adjective — имя прилагательное;
- verb — глагол;
- adverb — наречие;
Значение по умолчанию:
Включение или выключение отступов в JSON/XML ответе.
Позволяет включить или выключить пробельные отступы для ответа.
Поддерживаются следующие значения:
- yes — включить отступы;
- no — выключить отступы;
Значение по умолчанию:
Примечание.Все специальные символы должны быть экранированы.
Пример запроса (GET)
GET associations/v1.0/json/search?apikey=API-KEYlang=enlang=en charset=utf-8 Content-Length: 1240 Connection: keep-alive Keep-Alive: timeout=120 Date: Mon, 04 Jul 2016 23:59:25 GMT < «version»: «1.0», «code»: 200, «request»: < «text»: [ «welcome» ], «lang»: «en», «type»: «stimulus», «limit»: 6, «pos»: «noun,adjective,verb,adverb» >, «response»: [ < «text»: «welcome», «items»: [ < «item»: «Warmly», «weight»: 100, «pos»: «adverb» >, < «item»: «Hearty», «weight»: 98, «pos»: «adjective» >, < «item»: «Hospitable», «weight»: 94, «pos»: «adjective» >, < «item»: «Cordial», «weight»: 93, «pos»: «adjective» >, < «item»: «Heartily», «weight»: 85, «pos»: «adverb» >, < «item»: «Greet», «weight»: 84, «pos»: «verb» >] > ] >
XML-интерфейс
Ответ возвращается в формате XML.
Поддерживаются методы GET и POST.
Синтаксис запроса
https://api.wordassociations.net/associations/v1.0/xml/search? apikey= lang= [limit=] [indent=]
Слово или фраза, для которой необходимо найти ассоциации.
В запросе можно использовать несколько параметров text (от 1 до 10 включительно). Таким образом, в одном ответе можно получать ассоциации для нескольких входных слов или фраз.
- Для POST-запросов максимальный размер передаваемого текста составляет 10 000 символов.
- В GET-запросах ограничивается не размер передаваемого текста, а размер всей строки запроса, которая кроме текста может содержать и другие параметры. Максимальный размер строки — от 2 до 10 КБ (зависит от версии используемого браузера).
Размер входного текста неограничен. Однако подбор ассоциаций осуществляется лишь по первым 10 словам этого текста.
Задаётся в виде кода соответствующего языка.
- en — английский;
- es — испанский;
- it — итальянский;
- de — немецкий;
- pt — португальский;
- ru — русский;
- fr — французский;
Тип возвращаемого результата.
- stimulus — входными данными (параметр text ) является слово-ответ. Сервис возвращает список слов-стимулов, которые чаще всего побуждают подумать о заданном слове-ответе;
- response — входными данными (параметр text ) является слово-стимул. Сервис возвращает список ассоциативных слов-ответов, которые приходят на ум для заданного слова-стимула.
Значение по умолчанию:
Максимальное количество результатов.
Позволяет ограничить количество результатов (ассоциаций) в ответе. Параметр может принимать значение от 1 до 300.
Значение по умолчанию:
Искомые части речи.
Позволяет ограничивать результаты определёнными частями речи. Задаётся перечислением кодов частей речи, разделённых запятой.
Поддерживаются следующие коды:
- noun — имя существительное;
- adjective — имя прилагательное;
- verb — глагол;
- adverb — наречие;
Значение по умолчанию:
Включение или выключение отступов в JSON/XML ответе.
Позволяет включить или выключить пробельные отступы для ответа.
Поддерживаются следующие значения:
- yes — включить отступы;
- no — выключить отступы;
Значение по умолчанию:
Примечание.Все специальные символы должны быть экранированы.
Пример запроса (GET)
GET associations/v1.0/xml/search?apikey=API-KEYlang=enlang=en charset=utf-8 Content-Length: 68 Connection: keep-alive Keep-Alive: timeout=120 X-Content-Type-Options: nosniff Date: Thu, 31 Mar 2016 10:50:20 GMT welcome en stimulus 6 noun,adjective,verb,adverb welcome Warmly Hearty Hospitable Cordial Heartily Greet
Коды ответов
Описание возможных кодов ответов.
| 200 | Операция выполнена успешно |
| 401 | Неправильный API-ключ |
| 429 | Превышено ограничение на количество запросов за месяц |
| 501 | Заданный язык не поддерживается |
HTTP заголовки ответа
Описание HTTP заголовков, доступных на ответе.
| X-Quota-Limit | Максимальное количество запросов согласно тарифному плану. |
| X-Quota-Remaining | Оставшееся количество запросов. |
| X-Quota-Reset | Время в секундах до окончания интервала подписки. |
Источник: wordassociations.net
Краткое руководство по библиотеке Python Requests
Прежде чем начать, убедитесь, что установлена последняя версия Requests.
Для начала, давайте рассмотрим простые примеры.
Создание GET и POST запроса
Импортируйте модуль Requests:
import requests
Попробуем получить веб-страницу с помощью get-запроса. В этом примере давайте рассмотрим общий тайм-лайн GitHub:
r = requests.get(‘https://api.github.com/events’)