Autenticarse

Es muy importante que indique su identidad a la plataforma cuando efectúe solicitudes en la API; de lo contrario, le considerará un usuario anónimo y perderá los privilegios de acceso especiales que haya obtenido en portales o conjuntos de datos.

Para que la plataforma conozca su identidad, tiene que:

  • haber iniciado la sesión en un portal y efectuar consultas desde el portal en el portal (por ejemplo, mediante la consola); o bien

  • facilitar una clave de API junto con las solicitudes para identificarse de manera exclusiva.

Encontrar y generar claves de API

Para ver la lista de las claves de API, vaya a la página de su perfil en http://<youropendatasoftportal>.com/account/ (o haga clic en su nombre en el encabezado).

Una vez ahí, vaya a la ficha Mis claves de API para ver la lista de las claves activas, revocarlas y crear otras nuevas.

Importante

Aunque puede tener tantas claves como desee, todas lo identifican de manera idéntica. Es decir, todas conceden los mismos derechos (los suyos) a cualquier persona que las utilice. Por consiguiente, no debería compartir las claves.

Proporcionar claves de API en las solicitudes

Ahora que tiene una clave de API, puede pasarla con la solicitud por medio del parámetro de consulta apikey.

Para ilustrarlo, supongamos que ha configurado un portal privado y desea recuperar la lista de conjuntos de datos desde una aplicación externa que está creando.

Si la aplicación realiza esta llamada:

http://myprivateportal.opendatasoft.com/api/v2/catalog/datasets/

Recibirá un error 403 Forbidden.

Mientras que si efectúa esta llamada:

http://myprivateportal.opendatasoft.com/api/v2/catalog/datasets/?apikey=<myapikey>

Obtendrá un objeto JSON con la lista completa de los conjuntos de datos disponibles en el portal.