Antes de que comiences a escribir el código de tu primera aplicación cliente, hay unas cuantas tareas que debes realizar si aún no las has hecho.
Crea una Cuenta de Google
Necesitas una Cuenta de Google para crear un proyecto en la Consola de APIs de Google. Si ya tienes una cuenta, no tienes que hacer nada más.
También puedes usar Cuenta de Google separada para fines de prueba.
Crea un proyecto para tu cliente
Antes de poder enviar solicitudes a la API de Búsqueda en el Gráfico de conocimiento de Google, debes informar a Google sobre tu cliente y activar el acceso a la API. Para ello, debes usar la Consola de APIs de Google para crear un proyecto, que es una colección determinada de configuraciones y datos de acceso a la API, y registrar tu aplicación.
Para comenzar a usar la API de Google Knowledge Graph Search, primero debes usar la herramienta de configuración, que te guiará para crear un proyecto en la Consola de APIs de Google, habilitar la API y crear credenciales.
Si aún no lo hiciste, crea la clave de API de tu aplicación haciendo clic en Crear credenciales > Clave de API. A continuación, busca tu clave de API en la sección Claves de API.
Obtén información sobre los aspectos básicos de REST
Existen dos maneras de invocar la API:
- Enviar solicitudes HTTP y analizar las respuestas
- Usar bibliotecas cliente
Si decides no usar bibliotecas cliente, deberás comprender los aspectos básicos de REST.
REST es un estilo de arquitectura de software que proporciona un enfoque conveniente y coherente para solicitar y modificar datos.
El término REST es el acrónimo en inglés de "Transferencia de estado representacional". En el contexto de las API de Google, se refiere al uso de verbos HTTP para recuperar y modificar representaciones de los datos que almacena Google.
En un sistema RESTful, los recursos se almacenan en un almacén de datos; un cliente envía una solicitud para que el servidor ejecute una acción en particular (como crear, recuperar, actualizar o borrar un recurso) y el servidor ejecuta la acción y envía una respuesta que, por lo general, es una representación del recurso especificado.
En las APIs de RESTful de Google, el cliente especifica una acción con un verbo HTTP, como POST
, GET
, PUT
o DELETE
. Especifica un recurso mediante un URI único a nivel global con la siguiente forma:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Dado que todos los recursos de API tienen URI únicos accesibles a través de HTTP, REST permite el almacenamiento de datos en caché y está optimizado para funcionar con la infraestructura distribuida de la Web.
Puedes encontrar las definiciones de métodos en la documentación de estándares del HTTP 1.1, los que incluyen especificaciones para GET
, POST
, PUT
y DELETE
.
REST en la API de Búsqueda en el Gráfico de conocimiento de Google
Las operaciones de la API de Google Knowledge Graph Search se asignan directamente a los verbos HTTP de REST.
Los formatos específicos para los URI de la API de búsqueda en el Gráfico de conocimiento de Google son los siguientes:
https://kgsearch.googleapis.com/v1/entities:search?query=your_query¶meters
El conjunto completo de URI que se usa para cada operación compatible en la API se resume en el documento Referencia de la API de Google Knowledge Graph Search.
Obtén información sobre los aspectos básicos de JSON
La API de Búsqueda en el Gráfico de conocimiento de Google muestra datos en formato JSON.
JSON (JavaScript Object Notation) es un formato de datos común y, también, independiente del lenguaje que proporciona una representación de texto simple de estructuras de datos arbitrarias. Para obtener más información, visita json.org.