API
De JiskoWiki
--enconstruccion--
Tenemos una API muy parecida a la de Twitter, y la mayoría de los métodos están disponibles, pero no todos. Aún así, las aplicaciones con funciones básicas podrán utilizarla perfectamente.
Mientras lo escribimos, puedes mirar la documentación de Twitter y utilizarla de la misma manera, pero con Jisko.
NOTA: en nuestro caso, mantenemos una de las características de la anterior API. El usuario NO requiere la contraseña para usar la API, si no su clave API. Esto impide que, por unas causas u otras, alguien se hiciera con la contraseña y pudiera borrar la cuenta, cambiar la contraseña, el correo, jabber...
Autentificación
Para beneficiarse del uso de la API de Jisko es necesario el usuario y la clave API. La clave API tiene una longitud aproximada de 16 caracteres alfanuméricos que podremos cambiar desde las preferencias de [jisko.net jisko.net]
El método de autentificación escogido es HTTP BASIC AUTH, que se trata de una autentificación de mano del servidor soportada por la mayoría de lenguajes de programación. Puedes buscar más información sobre este tipo de autentificación en Google.
--Añadir ejemplos de autentificacion--
Sintaxis API
Como ya se ha comentado antes, la API es twitter-like, o lo que en español querría decir que es parecida a la de twitter, de todas formas todavía no está implementada completamente. Aun así te vamos a aclarar más o menos su uso, aunque la página de la documentación de la API de twitter no sería un mal sitio para empezar.
Métodos relacionados con las notas
public_timeline
URL: http://jisko.net/statuses/public_timeline.formato
Muestra las últimas 20 notas públicas de todos los usuarios. Funciona al estilo de http://jisko.net/public
Formatos: json, xml
Método(s): GET
Límite API: No hay límite
Parámetros: Todavía no disponibles
friends_timeline
URL: http://jisko.net/statuses/friends_timeline.formato
Muestra tus últimas 20 notas mezcladas con las notas de las personas a las que sigues.
Formatos: json, xml
Método(s): GET
Límite API: Límite... aplicable ¿?
Parámetros: Todavía no disponibles
user_timeline
URL: http://jisko.net/statuses/user_timeline.formato
Muestra las últimas 20 notas del usuario autentificado.
Formatos: json, xml
Método(s): GET
Límite API: Límite... aplicable ¿?
Parámetros: Todavía no disponibles
show (todavía no disponible)
URL: http://jisko.net/statuses/show/nota.formato
Muestra en el formato indicado la información sobre la nota solicitada
Formatos: json, xml
Método(s): GET
Límite API: Límite... aplicable ¿?
Parámetros:
- nota - obligatorio - La ID de la nota que se va a consultar
update
URL: http://jisko.net/statuses/update.formato
Envía una nueva nota a nombre del usuario autentificado
Formatos: json, xml
Método(s): POST
Límite API: Límite... aplicable ¿?
Parámetros:
- status - obligatorio - Contiene el contenido de la nota que se va a mandar
replies
URL: http://jisko.net/statuses/replies.formato
Devuelve las últimas 20 respuestas que se le hacen al usuario autentificado por medio del formato @usuario
Formatos: json, xml
Método(s): GET
Límite API: Límite... aplicable ¿?
Parámetros: Todavía no disponibles
destroy
URL: http://jisko.net/statuses/destroy/nota.formato
Borra la nota con el ID especificado
Formatos: json, xml
Método(s): POST
Límite API: Límite... aplicable ¿?
Parámetros:
- nota - obligatorio - El ID de la nota que se va a borrar
Métodos relacionados con los usuarios
friends
URL: http://jisko.net/statuses/friends.formato
Devuelve la información sobre los últimos 100 usuarios a los que se está siguiendo
Formatos: json, xml
Método(s): GET
Límite API: Límite... aplicable ¿?
Parámetros: Todavía no disponibles
followers
URL: http://jisko.net/statuses/followers.formato
Devuelve la información sobre los followers del usuario autentificado
Formatos: json, xml
Método(s): GET
Límite API: Límite... aplicable ¿?
Parámetros: Todavía no disponibles
show
URL: http://jisko.net/users/show/usuario.formato
Devuelve la información sobre los followers del usuario autentificado
Formatos: json, xml
Método(s): GET
Límite API: Límite... aplicable ¿?
Parámetros:
- usuario - obligatorio - La ID del usuario del que se va a obtener la información
Métodos relacionados con las notas privadas
direct_messages
URL: http://jisko.net/direct_messages.formato
Devuelve las 20 últimas notas privadas enviadas al usuario
Formatos: json, xml
Método(s): GET
Límite API: Límite... aplicable ¿?
Parámetros: Todavía no disponibles
sent
URL: http://jisko.net/direct_messages/sent.formato
Devuelves las 20 últimas notas privadas enviadas por el usuario
Formatos: json, xml
Método(s): GET
Límite API: Límite... aplicable ¿?
Parámetros: Todavía no disponibles
new
URL: http://jisko.net/direct_messages/new.formato
Envía una nueva nota privada
Formatos: json, xml
Método(s): POST
Límite API: Límite... aplicable ¿?
Parámetros:
- user - obligatorio - El ID o el Nick del usuario al que se va a enviar la nota privada
- status - obligatorio - El texto de la nota
destroy
URL: http://jisko.net/direct_messages/destroy/nota.formato
Borra la nota privada con el ID especificado
Formatos: json, xml
Método(s): POST
Límite API: Límite... aplicable ¿?
Parámetros:
- nota - obligatorio - El ID de la nota privada que se va a borrar
Métodos relacionados con las relaciones entre los usuarios
create
URL: http://jisko.net/friendships/create/id.formato
Se hace follow del usuario con el ID en cuestión. Si sucede algún fallo devuelve el fallo sucedido, en caso contrario devuelve la información sobre el usuario al que se va a seguir, en el formato establecido
Formatos: json, xml
Método(s): POST
Límite API: Límite... aplicable ¿?
Parámetros:
- id - obligatorio - La ID de la persona a la que se quiere seguir
destroy
URL: http://jisko.net/friendships/destroy/id.formato
Se deja de seguir al usuario con el ID en cuestión. Si sucede algún fallo devuelve el fallo sucedido, en caso contrario devuelve la información sobre el usuario que se deja de seguir, en el formato establecido
Formatos: json, xml
Método(s): POST
Límite API: Límite... aplicable ¿?
Parámetros:
- id - obligatorio - La ID de la persona a la que se quiere dejar de seguir
exists
URL: http://jisko.net/friendships/exists.formato
Comprueba si el usuario A sigue al usuario B
Formatos: json, xml
Método(s): GET
Límite API: Límite... aplicable ¿?
Parámetros:
- user_a - obligatorio - La ID o el Nick de la 1º persona por la que se va a probar el sistema
- user_b - obligatorio - La ID o el Nick de la 2º persona por la que se va a probar el sistema
Métodos de favoritos
favorites
URL: http://jisko.net/favorites.formato
Devuelve las 20 últimas notas favoritas del usuario autentificado
Formatos: json, xml
Método(s): GET
Límite API: Límite... aplicable ¿?
Parámetros: Todavía no disponibles
create
URL: http://jisko.net/favorites/create/nota.formato
Convierte la nota del ID especificado en favorita
Formatos: json, xml
Método(s): POST
Límite API: Límite... aplicable ¿?
Parámetros:
- nota - obligatorio - El ID de la nota que se va a convertir en favorita
destroy
URL: http://jisko.net/favorites/destroy/nota.formato
Quita el estado de favorita a la nota con el ID especificado
Formatos: json, xml
Método(s): POST
Límite API: Límite... aplicable ¿?
Parámetros:
- nota - obligatorio - El ID de la nota que va a dejar de ser favorita
