friends of cranebot api documentation

this is the documentation for the friends of cranebot webring api.

please note: all api functions are public and use the GET method. the friends of cranebot webring holds no sensitive or private data.

for beginners, see the widget page.

table of contents

• response structure
• api endpoints
  • base uri
  • random
  • webring data
  • member index
  • specific member
• member model reference

response structure

every successful non-redirect response returns a JSON with the same basic form:

• "status" containing the status code.
• "data" containing the desired data.

on an error:

• "status" containing the status code.
• "message" containing the error message.

api endpoints

get

base for api calls. will redirect to this page.

possible response statuses

• 303: see other

get

redirects to a random webring member's homepage.

• 302: found
• 404: page not found (i assume, if a site goes offline).

get

returns a package of webring data.

the intention for this endpoint is to provide assets for a webring member to arrange however they wish on their page.

possible response statuses

• 200: success

get

returns a json-array of all current members.

see member model reference for details.

possible response statuses

• 200: success

get example link

• param member-name: the name of the target member.

returns data for a specific member, their neighbors, and includes webring data delivered by /api/webring.

see member model reference for details.

possible response statuses

• 200: success
• 404: member not found

structure

the "data" object has the following attributes:

• "member": contains data for the queried member.
• "next": contains data for the member's next neighbor.
• "previous": contains data for the member's previous neighbor.
• "webring": contains data for the webring.

member model reference

a webring member is modeled with the following attributes: