Прежде чем вы сможете приступить к кодированию своего первого клиентского приложения, вам нужно сделать несколько вещей, если вы еще этого не сделали.
Получите учетную запись Google
Вам потребуется учетная запись Google , чтобы создать проект в Google API Console. Если у вас уже есть учетная запись, то все готово.
Вам также может понадобиться отдельная учетная запись Google для целей тестирования.
Создайте проект для вашего клиента
Прежде чем вы сможете отправлять запросы к Google Knowledge Graph Search API, вам необходимо сообщить Google о своем клиенте и активировать доступ к API. Вы делаете это, используя Google API Console для создания проекта , который представляет собой именованный набор настроек и информации о доступе к API, и регистрируете свое приложение.
Чтобы приступить к работе с Google Knowledge Graph Search API, вам необходимо сначала использовать инструмент настройки , который поможет вам создать проект в консоли Google API, включить API и создать учетные данные.
Если вы еще этого не сделали, создайте ключ API своего приложения, щелкнув Создать учетные данные > Ключ API . Затем найдите свой ключ API в разделе ключей API .
Изучите основы REST
Существует два способа вызова API:
- Отправка HTTP-запросов и анализ ответов.
- Использование клиентских библиотек .
Если вы решите не использовать клиентские библиотеки, вам необходимо понять основы REST.
REST — это стиль архитектуры программного обеспечения, обеспечивающий удобный и последовательный подход к запросу и изменению данных.
Термин REST является сокращением от « Передача репрезентативного состояния ». В контексте API Google это относится к использованию глаголов HTTP для извлечения и изменения представлений данных, хранящихся в Google.
В системе RESTful ресурсы хранятся в хранилище данных; клиент отправляет запрос серверу на выполнение определенного действия (например, создание, извлечение, обновление или удаление ресурса), а сервер выполняет действие и отправляет ответ, часто в форме представления указанного ресурса.
В RESTful API Google клиент указывает действие с помощью команды HTTP, такой как POST , GET , PUT или DELETE . Он определяет ресурс с помощью глобально уникального URI следующего вида:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Поскольку все ресурсы API имеют уникальные доступные по HTTP URI, REST обеспечивает кэширование данных и оптимизирован для работы с распределенной сетевой инфраструктурой.
Вы можете найти полезными определения методов в документации по стандартам HTTP 1.1; они включают спецификации для GET , POST , PUT и DELETE .
REST в API поиска Google Knowledge Graph
Операции Google Knowledge Graph Search API сопоставляются непосредственно с HTTP-командами REST.
Конкретные форматы для URI Google Knowledge Graph Search API:
https://kgsearch.googleapis.com/v1/entities:search?query=your_query¶meters
Полный набор URI, используемых для каждой поддерживаемой операции в API, приведен в справочном документе Google Knowledge Graph Search API .
Изучите основы JSON
Google Knowledge Graph Search API возвращает данные в формате JSON.
JSON (нотация объектов JavaScript) — это распространенный независимый от языка формат данных, обеспечивающий простое текстовое представление произвольных структур данных. Для получения дополнительной информации см. json.org .