wiki:API_brainstorm

API brainstorm

We don't have an API yet. This page intends to collect some ideas about an upcoming API.

Planned features

  • Read and write profile data (see prototype)
  • Search members
  • Send and receive member-to-member messages

Entry point

The API will be RESTful. Possibilities base URIs are:

  1. https://api.bewelcome.org/ (ruled out)
  2. https://www.bewelcome.org/api/ - Saves SSL certificate trouble

Authentication

  • Anonymous and authenticated calls supported
  • Authentication via username and password
  • Authentication remains valid during session (via cookie?)

Output format

  • JSON is standard in most modern APIs

Connection to back-end

Possibilities:

  1. Internal HTTP calls to different subsystems
  2. New Rox module "api" (in "build" folder) - see prototype
  3. Both :)

Links for inspiration

Last modified 4 years ago Last modified on Oct 21, 2012 8:56:11 AM