¿Cómo debe ser la API ideal de Poderopedia?

71 views
Skip to first unread message

Miguel Paz

unread,
Jul 20, 2012, 1:35:38 PM7/20/12
to poderope...@googlegroups.com
Hola a todos!

Estamos comenzando a trabajar en el desarrollo de la API de Poderopedia y para ello hemos definido ciertos requerimientos básicos:

1. Ninguna API sirve si no es usada por sus creadores: Por lo tanto la API de Poderopedia debe ser diseñada para su uso por Poderopedia y para otros proyectos y servicios web de la Fundación Poderomedia.

2. La API debe ser fácil de usar y debe apoyarse en estándares ya probados y aprobados por la comunidad

3. La información que podrás extraer de Poderopedia incluye:

-Información básica de una persona, empresa o institución (bio básica, avatar, industria, país, sitio web, redes sociales)
-Perfil periodístico
-Ficha de datos duros de conexiones (padre de, hermano de, primo de, casado con, socio mayoritario de compañía A, accionista de compañía B, gerente general de compañía C, Miembro del directorio de compañía D, Socio/Miembro de ONG E, Ministro de F en G Gobierno, Miembro de H Cub Privado, Miembro de I Grupo Religioso, Miembro de J Grupo Secular, etc)
-Visualización de mapas de relaciones 
-Documentos relacionados a una persona, empresa u organización (usamos la tecnología de Documentcloud integrada a Poderopedia)
-Fuentes de información

Toda la información mencionada arriba está marcada con PoderVocabulary, el vocabulario controlado usado como metadata por Poderopedia.

Preguntas y comentarios

1. Para que todos podamos consumir información de Poderopedia y reutilizarla ¿debiéramos tener una gran API con todos los servicios o crear API`s de servicios separados? 

2. Método HTTP y formato Response: Hasta ahora nos inclinamos por HHTP / GET y RESPONSE / XML y JSON. Si tienes comentarios al respecto, bienvenidos!

3. API`s de referencia que nos gustan mucho (por servicios prestados, forma de entregar los servicios y documentación):


Carolina Sandoval

unread,
Jul 20, 2012, 1:50:13 PM7/20/12
to poderope...@googlegroups.com
Hola,
opinión respecto a

1. Para que todos podamos consumir información de Poderopedia y reutilizarla ¿debiéramos tener una gran API con todos los servicios o crear API`s de servicios separados?

Creo que estratégicamente nos conviene más crear API's de servicios separados, es decir, ramas de vocabulario específico abiertas a ampliarse por el público, porque no sólo hace explítico el nivel de especificidad del vocabulario que tenemos ahora sino que abre la posibilidad para que gente de distintos campos del conocimiento participe enriqueciendo estas API's ya sea a nivel técnico o conceptual. (con código o discusiones, opiniones respecto de su uso o significancia)

Esop.
C.

2012/7/20 Miguel Paz <mig...@poderopedia.com>

--
Has recibido este mensaje porque estás suscrito al grupo "Poderopedia grupo de discusión / discussion group" de Grupos de Google.
Para publicar una entrada en este grupo, envía un correo electrónico a poderope...@googlegroups.com.
Para anular tu suscripción a este grupo, envía un correo electrónico a poderopedia-us...@googlegroups.com
Para ver este debate en la Web, visita https://groups.google.com/d/msg/poderopedia-users/-/QfF4MH9pZCgJ.
Para obtener más opciones, visita https://groups.google.com/groups/opt_out.
 
 

Alvaro Graves

unread,
Jul 20, 2012, 2:23:32 PM7/20/12
to poderope...@googlegroups.com
Creo que hay 3 funcionalidades que me gustaría ver en una API de poderopedia:

- Búsqueda por texto: Quiero que me des todos las personas/empresas/organizaciones que cuyo nombre of descripción contengan la palabra "piñera"
- Descripción de persona/empresa/organización: Quiero información sobre una persona en particular. Pueden haber varios niveles de detalle que puedo especificar (ej. nivel 1 nombre, apellidos, trabajo y familia, nivel 2 idem + historia laboral y de estudios, nivel 3 todo lo que haya, incluyendo fuentes)
- Búsqueda de relación entre personas/empresas/organizaciones: Dado 2 entidades, dame todas las relaciones que tengan con una distancia igual o menor a 3. (ej: Piñera y Chadwick están unidos por varias relaciones de distinto tipo).

Yo me enfocaría en JSON y dejaría XML sólo si hay tiempo.

Mis 0.02USD

Alvaro Graves-Fuenzalida
Web: http://graves.cl - http://ManzanaMecanica.org Twitter: @alvarograves


2012/7/20 Carolina Sandoval <caro...@poderopedia.com>

Alvaro Graves

unread,
Jul 20, 2012, 2:27:57 PM7/20/12
to poderope...@googlegroups.com
Se me olvidaba: Es altamente recomendable tener una interfaz web para poder probar la API, eso va a ayudar mucho a la hora de aprender a usarla.

Alvaro Graves-Fuenzalida
Web: http://graves.cl - http://ManzanaMecanica.org Twitter: @alvarograves


2012/7/20 Alvaro Graves <alv...@graves.cl>

Miguel Paz

unread,
Jul 20, 2012, 4:12:18 PM7/20/12
to poderope...@googlegroups.com, alv...@graves.cl
Como plantean Alvaro y Carolina, al parecer lo mejor es proponer una API con distintas funcionalidades o varias API con funcionalidades específicas.
Alvaro: Tienes algún ejemplo de "interfaz web para poder probar la API"
2012/7/20 Alvaro Graves <alv...@graves.cl>



2012/7/20 Carolina Sandoval <caro...@poderopedia.com>


2012/7/20 Miguel Paz <mig...@poderopedia.com>
Para publicar una entrada en este grupo, envía un correo electrónico a poderopedia-users@googlegroups.com.
Para anular tu suscripción a este grupo, envía un correo electrónico a poderopedia-users+unsubscribe@googlegroups.com

Para ver este debate en la Web, visita https://groups.google.com/d/msg/poderopedia-users/-/QfF4MH9pZCgJ.
Para obtener más opciones, visita https://groups.google.com/groups/opt_out.
 
 

--
Has recibido este mensaje porque estás suscrito al grupo "Poderopedia grupo de discusión / discussion group" de Grupos de Google.
Para publicar una entrada en este grupo, envía un correo electrónico a poderopedia-users@googlegroups.com.
Para anular tu suscripción a este grupo, envía un correo electrónico a poderopedia-users+unsubscribe@googlegroups.com

Alvaro Graves

unread,
Jul 20, 2012, 4:14:44 PM7/20/12
to poderope...@googlegroups.com
La API Console del NYT


Me faltó decir que estamos hablando de API basada en REST y HTTP, cierto?


Alvaro Graves-Fuenzalida
Web: http://graves.cl - http://ManzanaMecanica.org Twitter: @alvarograves


2012/7/20 Miguel Paz <mig...@poderopedia.com>
Para publicar una entrada en este grupo, envía un correo electrónico a poderope...@googlegroups.com.
Para anular tu suscripción a este grupo, envía un correo electrónico a poderopedia-us...@googlegroups.com
Para ver este debate en la Web, visita https://groups.google.com/d/msg/poderopedia-users/-/1jmGHyCuxKEJ.

Cassiano Gobbet

unread,
Jul 23, 2012, 3:28:36 PM7/23/12
to poderope...@googlegroups.com
Hola;

en primer lugar, perdón por mi español pobre. Intento escribir el más claro posible, pero estoy consciente de mis limites :-)

Yo creo que concordo con Carolina. Para el inicio, hacer APIs diferentes seria una opción mejor. Mismo que ustedes tengan muy claro el concepto e sepan que quieren hacer, es muy, muy probable que cuando la comunidad  empezar a utilizar el servicio, nuevas necesidades surgirán y algunas de elaos serán nuevas para vosotros mismos. Por lo tanto, APIs separadas e menores pueden ser hechas conforme las necesidades ya sabidas y creo que es más fácil para empezar varios pequeños proyectos que fijar muchas veces un grande . Más adelante, cuando la mayoría de las necesidades básicas estean resueltas, ustedes podrían considerar la construcción de un API más robusta, donde todas las demandas sean respondidas.

Saludos


Reply all
Reply to author
Forward
0 new messages