« API » : différence entre les versions

An alternative space dedicated to technology and culture at Charleroi.
Aller à la navigation Aller à la recherche
(+/design/kibaone/accents +design/footer)
Ligne 6 : Ligne 6 :


== /pads ==
== /pads ==
* '''Purpose:''' Returns a list of the pads on the Wolfplex Etherpad installation
* '''URL:''' {{api|pads}}
* '''URL:''' {{api|pads}}
* '''Method:''' GET
* '''Method:''' GET
* '''Parameters:'''
* '''Parameters:'''
** format=json|raw|txt (default: json) — Output format
** format=json|raw|txt (default: json) — Output format
* '''Purpose:''' Returns a list of the pads on the Wolfplex Etherpad installation


== /space ==
== /space ==
* '''Purpose:''' Returns a JSON document compliant with [http://spaceapi.net/ Space API] ([http://spaceapi.net/documentation format documentation)]
* '''URL:''' {{api|space}}
* '''URL:''' {{api|space}}
* '''Method:''' GET
* '''Method:''' GET
* '''Parameters:''' none
* '''Parameters:''' none
* '''Purpose:''' Returns a JSON document compliant with [http://spaceapi.net/ Space API] ([http://spaceapi.net/documentation format documentation)]
 
= Design API Documentation =
 
== /design/footer ==
''Not yet available.''
* '''Purpose:''' Servers a footer HTML code to add in a Wolfplex document
* '''URL:''' {{api|design/footer}}
* '''Parameters:'''
** content=full|common-column — Code selection
*** content=full — returns the full footer HTML code
*** content=common-column — returns the HTML code for the content of the second footer column, allowing you to personalize the 3 others
 
== /design/kibaone ==
This provides features specific to the Kiba One theme (see also [[Kiba]]).
 
=== /design/kibaone/accents ===
* '''Purpose:''' Returns a JSON document with a listing of Kiba One accents.
* '''URL:''' {{api|design/kibaone/accents}}
* '''Method:''' GET
* '''Parameters:''' none
* '''Format:''' An array of object, each one having 3 properties:
** '''name''': the accent name
** '''accent''': the background color
** '''headingColor''': the heading color

Version du 31 octobre 2013 à 16:49

To provide data about Wolfplex, we offer an API.

Domain: http://api.wolfplex.be/

API Documentation

/pads

  • Purpose: Returns a list of the pads on the Wolfplex Etherpad installation
  • URL: http://api.wolfplex.be/pads
  • Method: GET
  • Parameters:
    • format=json|raw|txt (default: json) — Output format

/space

Design API Documentation

/design/footer

Not yet available.

  • Purpose: Servers a footer HTML code to add in a Wolfplex document
  • URL: http://api.wolfplex.be/design/footer
  • Parameters:
    • content=full|common-column — Code selection
      • content=full — returns the full footer HTML code
      • content=common-column — returns the HTML code for the content of the second footer column, allowing you to personalize the 3 others

/design/kibaone

This provides features specific to the Kiba One theme (see also Kiba).

/design/kibaone/accents

  • Purpose: Returns a JSON document with a listing of Kiba One accents.
  • URL: http://api.wolfplex.be/design/kibaone/accents
  • Method: GET
  • Parameters: none
  • Format: An array of object, each one having 3 properties:
    • name: the accent name
    • accent: the background color
    • headingColor: the heading color