The Liberation Pledge API

This is an API back-end used by The Liberation Pledge website. Presently is has just one endpoint: /pledgers, which is used to return information about the most recent pledgers.

The Liberation Pledge website is hosted on SquareSpace.

Usage

Example request:

GET http://liberationpledge-api.dxetech.org/pledgers?limit=10

See the Facebook Data example_request.html for an example of how to make a request to this endpoint from JavaScript without jQuery.

See server.py for the full functionality.

Local Development

WIP

Deployment

This app is deployed with Dokku. Learn about how DxE Tech deploys with Dokku. The Dokku git remote is:

dokku@dxetech.org:liberationpledge-api

Configuration

You will need the following environment variables, both locally and in production:

• GOOGLE_API_CLIENT_EMAIL
• GOOGLE_API_PRIVATE_KEY
• LIBERATION_PLEDGE_SHEET_ID

Setting Up The Google Spreadsheets API

Get Credentials

This comes from here.

1. Visit https://console.developers.google.com/project
2. Create a project.
3. On the left bar navigate to 'APIs & auth' > 'APIs' > 'Drive API'
4. Click 'Enable API'
5. On the left bar navigate to 'APIs & auth' > 'APIs' > 'Credentials'
6. Click 'Add Credentials', select 'Service Account', json filetype, and 'Create' You'll then download a json file containing the credentials.

Give API Access To Spreadsheets

In order for the to actually access the specific spreadsheet, you have to give permissions in the same way you would give a user access to a spreadsheet. Go to the spreadsheet, on the top right click 'Share', and enter the email address found under client_email in the api credentials file you just downloaded.

Full Spreadsheets API

A python libaray wrapping the Google Sheets API for interfacing with spreadsheets is gspread.

The documentation is here on readthedocs. One important detail about the API is that all cells are returned as strings despite the underlying spreadsheet cell format.

License

liberationpledge-api is licensed under GNU GPL version 3.0. For the full license see the LICENSE file.