yetangitu/photo-documentation
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
photo-documentation/docs/api
History
Jaisen Mathai f22ce1ca1d Initial checkin of docs
2013-01-28 22:49:14 -05:00
..
Authentication.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
Envelope.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
GetActivities.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
GetGroup.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
GetGroups.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
GetHelloWorld.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
GetPhoto.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
GetPhotoNextPrevious.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
GetPhotos.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
GetTags.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
GetWebhook.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
GetWebhooks.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
PostActionCreate.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
PostActionDelete.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
PostGroupCreate.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
PostGroupDelete.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
PostGroupUpdate.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
PostPhotoDelete.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
PostPhotoUpdate.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
PostPhotoUpload.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
PostTagCreate.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
PostTagUpdate.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
PostWebhookDelete.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
PostWebhookSubscribe.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00
Readme.markdown Initial checkin of docs 2013-01-28 22:49:14 -05:00

Readme.markdown

Open Photo API

How do I authenticate?

The Open Photo API uses OAuth1.0a for authentication. See the complete guide on authentication for details.

What's the response format?

Every API endpoint returns a JSON response in a standard envelope.

{
  message: "A string describing the response",
  code: 200,
  result: {
    foo: "bar"
  }
}

API Endpoints

Test / diagnostics endpoints

  1. GET /hello.json Test endpoint.

Action endpoings (comments, favorites, etc)

  1. POST /action/:id/:type/create.json Create an action.
  2. POST /action/:id/delete.json Delete an action.

Photo endpoints

  1. POST /photos/:id/delete.json Delete a user's photo.
  2. POST /photos/:id/update.json Update data on a user's photo.
  3. GET /photo/:id/view.json Get a user's photo.
  4. GET /photos/list.json Get a list of the user's photos.
  5. GET /photo/:id/nextprevious.json Get the next and previous photo.
  6. POST /photo/upload.json Upload a new photo.

Tag endpoints

  1. GET /tags/list.json Get a user's tags.
  2. POST /tag/create.json Create a tag for the user.
  3. POST /tag/:id/update.json Modify meta data for a user's tag.

Group endpoints

  1. GET /group/:id/view.json Get a group.
  2. GET /groups/list.json Get a listing of a user's groups.
  3. POST /group/create.json Create a group.
  4. POST /group/delete.json Delete a group.
  5. POST /group/update.json Update a group.

Webhook endpoints

  1. POST /webhook/subscribe Update an eixsting webhook.
  2. GET /webhook/:id/view.json Get a user's webhook by id.
  3. POST /webhook/:id/delete.json Delete an existing webhook.