Tutorial oaut

Tutorial OAUT con google (gmail).

Preparar

Hay unos pocos pasos de configuración que necesita para completar antes de poder utilizar esta biblioteca:

1. Si aún no dispone de una cuenta de Google, inscribirse .
2. Si usted nunca ha creado un proyecto API de Google, lea la página de Gestión de Proyectos y crear un proyecto en la consola de desarrolladores de Google
3. Instalar la biblioteca.

Autenticación y autorización

Es importante entender los conceptos básicos de cómo se manejan la autenticación y autorización de API. Todas las llamadas a la API deben utilizar ya sea simple o acceso autorizado (se define a continuación). Muchos métodos de la API requieren acceso autorizado, pero algunos pueden utilizar. Algunos métodos de la API que pueden utilizar cualquiera comportan de manera diferente, dependiendo de si se utiliza un acceso simple o autorizado. Consulte la documentación método de la API para determinar el tipo de acceso adecuado.

1. acceso a la API simple (claves API)

Estas llamadas a la API no tienen acceso a los datos privados de los usuarios. La aplicación debe autenticarse como una aplicación perteneciente a su Google Desarrolladores consola se necesita project.This para medir el uso del proyecto a efectos contables.

Conceptos importantes

• Clave de API: Para autenticar su aplicación, utilice una clave de API para su Google Consola Desarrolladores proyecto. Cada acceso sencillo llamar a sus marcas de solicitud debe incluir esta tecla.

Advertencia: Mantenga su clave privada API. Si alguien obtiene su clave, que podrían utilizarlo para consumir su cuota o incurrir en cargos contra su proyecto Google consola de desarrolladores.

2. Acceso API Autorizado (OAuth 2.0)

Estas llamadas a la API acceder a los datos privados de los usuarios. Antes de que pueda llamar a ellos, el usuario que tiene acceso a los datos privados debe otorgar el acceso a las aplicaciones. Por lo tanto, su aplicación debe ser autenticado, el usuario debe conceder acceso para su aplicación, y el usuario debe estar autenticado para conceder ese acceso. Todo esto se logra con OAuth 2.0 y bibliotecas escritas por él.

Conceptos importantes

• Alcance: Cada API define uno o más ámbitos que declaran un conjunto de operaciones permitidas. Por ejemplo, una API podría haber sólo lectura y de lectura y escritura ámbitos. Cuando su aplicación solicita acceso a los datos del usuario, la solicitud debe incluir una o más ámbitos. El usuario tiene que aprobar el alcance del acceso a su aplicación está solicitando.
• Actualizar y acceso tokens: Cuando un usuario otorga su acceso a las aplicaciones, el servidor de autorización OAuth 2.0 proporciona su aplicación con actualización y acceso fichas. Estas fichas son válidas sólo para el ámbito solicitado. Su aplicación utiliza tokens de acceso para autorizar llamadas a la API. Los tokens de acceso caducan, pero las fichas de refresco no. Su aplicación puede utilizar un identificador de actualización para adquirir un nuevo token de acceso.

Advertencia: Mantenga actualización y acceso a fichas privado. Si alguien obtiene sus tokens, podrían utilizarlos para acceder a los datos privados de los usuarios.

• ID de cliente y secreto cliente: Estas cadenas se identifican de forma única su aplicación y se utilizan para adquirir fichas. Son creados para su proyecto Google Consola Desarrolladores en el panel de Acceso a la API de la Consola de Desarrolladores Google. Hay tres tipos de ID de cliente, así que asegúrese de obtener el tipo correcto para su aplicación:

• ID de cliente de aplicaciones Web
• ID de cliente de aplicaciones instaladas
• Servicio de Cuenta ID de cliente

Advertencia: Mantenga su cliente secreto privado. Si alguien obtiene su secreto cliente, podrían utilizarlo para consumir su cuota, incurrirá en cargos contra su proyecto Google consola de desarrolladores, y el acceso a la solicitud de datos de usuario.

La construcción y llamar a un servicio

En esta sección se describe cómo construir un objeto de servicio con una API específica, hacer llamadas al servicio, y procesar la respuesta.

Construir el objeto cliente

El objeto de cliente es el contenedor primario para las clases y la configuración de la biblioteca.

$client = new Google_Client(); $client->setApplicationName("My Application"); $client->setDeveloperKey(MY_SIMPLE_API_KEY); 

Construir el objeto de servicio

Los servicios se llaman a través de consultas al servicio de objetos específicos. Estos son creados por la construcción del objeto de servicio, y que pasa una instancia de Google_Client a ella. Google_Client contiene la IO, la autenticación y otras clases requeridas por el servicio de funcionar, y el servicio informa al cliente de que alcances que utiliza para proporcionar un valor predeterminado al autenticar un usuario.

 $service = new Google_Service_Books($client); 

Llamar a una API

Cada API proporciona recursos y métodos, por lo general en una cadena. Se puede acceder desde el objeto de servicio en la forma $service->resource->method(args) . La mayoría método requiere algunos argumentos, entonces aceptan un parámetro final de una matriz que contiene los parámetros opcionales. Por ejemplo, con la API de Google Books, podemos hacer una llamada a la lista de volúmenes que coincidan con una determinada cadena, y añadir un parámetro de filtro opcional.

...