Diferencia entre revisiones de «API»

De ChatHispano
Saltar a: navegación, buscar
m (Nicks)
m (Nicks)
Línea 10: Línea 10:
 
* Perfil de usuario
 
* Perfil de usuario
  
[[GET nick/profile]]: Devuelve el perfil de usuario
+
[[GET nick/profile/<nick>]]: Devuelve el perfil de usuario
  
[[POST nick/profile/set]]: Ajusta parámetros del perfil de usuario
+
[[POST nick/profile/<nick>/set]]: Ajusta parámetros del perfil de usuario
  
 
* Estado del nick
 
* Estado del nick
  
[[GET nick/status]]: Devuelve el estado actual del nick
+
[[GET nick/<nick>/status]]: Devuelve el estado actual del nick
  
[[POST nick/register]]: Nos registra un nick
+
[[POST nick/<nick>/register]]: Nos registra un nick
  
[[POST nick/expire]]: Nos expira un nick
+
[[POST nick/<nick>/expire]]: Nos expira un nick
  
[[POST nick/suspend]]: Nos suspende un nick
+
[[POST nick/<nick>/suspend]]: Nos suspende un nick
  
[[POST nick/forbid]]: Nos forbidea un nick
+
[[POST nick/<nick>/forbid]]: Nos forbidea un nick
  
 
* IP Virtual Personalizada
 
* IP Virtual Personalizada
  
[[GET nick/ipvirtual/agenda]]: Nos devuelve la lista de ips personalizadas en la agenda de ipvirtual
+
[[GET nick/<nick>/ipvirtual/agenda]]: Nos devuelve la lista de ips personalizadas en la agenda de ipvirtual
  
[[POST nick/ipvirtual/agenda/add]]: Nos añade una ip virtual a la agenda
+
[[POST nick/<nick>/ipvirtual/agenda/add]]: Nos añade una ip virtual a la agenda
  
[[POST nick/ipvirtual/agenda/drop]]: Nos quita una ip virtual de la agenda
+
[[POST nick/<nick>/ipvirtual/agenda/drop/<id>]]: Nos quita una ip virtual de la agenda
  
[[GET nick/ipvirtual]]: Nos devuelve la configuración de la ip virtual personalizada
+
[[GET nick/<nick>/ipvirtual]]: Nos devuelve la configuración de la ip virtual personalizada
  
[[POST nick/ipvirtual/set]]: Nos cambia la ip virtual personalizada
+
[[POST nick/<nick>/ipvirtual/set]]: Nos cambia la ip virtual personalizada
  
[[POST nick/ipvirtual/suspend]]: Nos suspende el acceso a ipvirtual
+
[[POST nick/<nick>/ipvirtual/suspend]]: Nos suspende el acceso a ipvirtual
  
 
* Acciones sobre nicks
 
* Acciones sobre nicks
  
[[POST nick/kill]]: Expulsa del IRC con un kill
+
[[POST nick/<nick>/kill]]: Expulsa del IRC con un kill
  
[[POST nick/gline]]: Expulsa del IRC con un G-Line
+
[[POST nick/<nick>/gline]]: Expulsa del IRC con un G-Line
  
 
== Información de canales ==
 
== Información de canales ==

Revisión del 18:19 24 jun 2014

Información general sobre el API

El raíz está en https://api.chathispano.com/1.0/

Es necesario un certificado aceptado por Chat Hispano para autenticar al llamante.


Nicks

  • Perfil de usuario

[[GET nick/profile/<nick>]]: Devuelve el perfil de usuario

[[POST nick/profile/<nick>/set]]: Ajusta parámetros del perfil de usuario

  • Estado del nick

[[GET nick/<nick>/status]]: Devuelve el estado actual del nick

[[POST nick/<nick>/register]]: Nos registra un nick

[[POST nick/<nick>/expire]]: Nos expira un nick

[[POST nick/<nick>/suspend]]: Nos suspende un nick

[[POST nick/<nick>/forbid]]: Nos forbidea un nick

  • IP Virtual Personalizada

[[GET nick/<nick>/ipvirtual/agenda]]: Nos devuelve la lista de ips personalizadas en la agenda de ipvirtual

[[POST nick/<nick>/ipvirtual/agenda/add]]: Nos añade una ip virtual a la agenda

[[POST nick/<nick>/ipvirtual/agenda/drop/<id>]]: Nos quita una ip virtual de la agenda

[[GET nick/<nick>/ipvirtual]]: Nos devuelve la configuración de la ip virtual personalizada

[[POST nick/<nick>/ipvirtual/set]]: Nos cambia la ip virtual personalizada

[[POST nick/<nick>/ipvirtual/suspend]]: Nos suspende el acceso a ipvirtual

  • Acciones sobre nicks

[[POST nick/<nick>/kill]]: Expulsa del IRC con un kill

[[POST nick/<nick>/gline]]: Expulsa del IRC con un G-Line

Información de canales

GET channel/profile: Devuelve datos sobre canales

Acciones sobre canales

POST channel/profile: Ajusta datos de canales