An open source member signup and billing management API for coworking spaces.
-
Create a new app on parse.com. Call it
binto_api_production. -
Run the following commands.
git clone https://github.com/riversideio/binto-api.git
cd binto-api
heroku create
heroku addons:add sendgrid
heroku config:set PARSE_APP_ID=your_parse_app_id PARSE_REST_API_KEY=your_parse_rest_api_key
heroku config:set STRIPE_SECRET_KEY=your_stripe_secret_key STRIPE_PLAN_ID=riversideio100
heroku config:set SMTP_USERNAME=smtp_username SMTP_PASSWORD=smtp_password SMTP_HOST=smtp.sendgrid.net SMTP_PORT=587 FROM=billing@riverside.io
git push heroku master
You're done. Make your first request.
curl -X GET http://yoursubdomain.herokuapp.com/api/v0/users.json
Gets the list of users.
curl -X GET http://localhost:3000/api/v0/users.json
Creates a user.
curl -X POST http://localhost:3000/api/v0/users.json \
-d "email=you@youremail.com" \
-d "password=password"
Gets a user.
curl -X GET http://localhost:3000/api/v0/users/JTQKXcajdP/show.json
Updates a user's attributes. Requires a session_token.
curl -X POST http://localhost:3000/api/v0/users/JTQKXcajdP/update.json \
-d "session_token=cqo4zl2ocs4ati8c51ugs6mtt" \
-d "stripe_customer_id=1234"
Updates a user's credit card on file. Creates one if not yet existing. Requires a session_token.
curl -X POST http://localhost:3000/api/v0/users/JTQKXcajdP/update_card.json \
-d "session_token=cqo4zl2ocs4ati8c51ugs6mtt" \
-d "card_number=4242424242424242" \
-d "card_cvc=123" \
-d "card_exp_month=7" \
-d "card_exp_year=18"
Updates a users subscription to Stripe, requires a plan and session_token.
curl -X POST http://localhost:3000/api/v0/users/me/update_plan.json \
-d "session_token=cqo4zl2ocs4ati8c51ugs6mtt" \
-d "plan=BALLERZ12"
Cancel a users subscription to Stripe, requires a session_token.
curl -X POST http://localhost:3000/api/v0/users/me/cancel_plan.json \
-d "session_token=cqo4zl2ocs4ati8c51ugs6mtt"
Request a password reset email from Parse. Requires just email of user.
curl -X POST http://localhost:3000/api/v0/users/reset_password.json \
-d "email=bobdillin@coolpickels.com" \
Charges a user's credit card to a specified amount, currently only works with inputted cards. Requires a session_token.
curl -X POST http://localhost:3000/api/v0/users/JTQKXcajdP/charge.json \
-d "session_token=cqo4zl2ocs4ati8c51ugs6mtt" \
-d "card_number=4242424242424242" \
-d "card_cvc=123" \
-d "card_exp_month=7" \
-d "card_exp_year=18" \
-d "amount=5000"
Lets the user login and returns the sessionToken.
curl -X POST http://localhost:3000/api/v0/sessions.json \
-d "email=you@youremail.com" \
-d "password=password"
Gets a list of white listed plans for the user to select on signup.
curl -X GET http://localhost:3000/api/v0/plans.json
Note: You can blacklist plans (if you want to keep some secret). Set your environment variable PLAN_BLACKLIST. Seperate multiple ones with commas. heroku config:set PLAN_BLACKLIST=plan1,plan2
Gets a list of checkins.
curl -X GET http://localhost:3000/api/v0/checkins.json
Creates a checkin.
curl -X POST http://localhost:3000/api/v0/checkins.json
Gets a list of events
curl -X GET http://localhost:3000/api/v0/events.json
There are a series of differnt parameter that can be passed with to get certain criteria of events. Right now the current adapter is using Google Calendars API v3 so use the referance to their params.
Create an Event
curl -X POST http://localhost:3000/api/v0/events.json \
-d "start={DateTime}" \
-d "end={DateTime}" \
-d "title=Hello World" \
-d "decription=Things and Stuff"
Right now the only params available are the ones listed in the call. start and end are the only require field and use a Date Time formatted according to RFC 3339. eg. moment().format()
Create a new app on parse.com. Call it binto_api_development.
Run the following commands.
npm install
cp .env.example .env
vim .env
Set the following values.
PARSE_APP_ID=your_stripe_id
PARSE_REST_API_KEY=your_parse_api_key
STRIPE_PLAN_ID=
STRIPE_SECRET_KEY=
Startup the application.
node app.js
Now you can create your first user.
curl -X POST http://localhost:3000/api/v0/users.json \
-d "email=you@youremail.com" \
-d "password=password"
Next trying logging that user in.
curl -X POST http://localhost:3000/api/v0/sessions.json \
-d "email=you@youremail.com" \
-d "password=password"
Note the session_token that comes back. Next try updating that user.
curl -X POST http://localhost:3000/api/v0/users/JTQKXcajdP/update.json \
-d "session_token=cqo4zl2ocs4ati8c51ugs6mtt" \
-d "stripe_customer_id=1234"
Just added to the list of endpoints is events. The built in calendar we use is Google Calendar. We get access to this using a Service Account for authentication. To get a key for the service account go to your Google API Console make sure calendar access is switched on in APIs & Auth > APIs. Now go to APIs & Auth > Credentials and "Create a New Client ID". This will pop up a modal toggle the radio inputs to "Service Account", then click "Create Client ID". This will download a file and give you a passcode to unlock the file this is usually "notasecret".
Once you have this file downloaded store this p12 file into pem with openssl.
openssl pkcs12 -in yourkey.p12 -out yourkey.pem -nodes
Now we host on heroku and this is a open project so we cannot be storing that file in our project or everyone would have access to this file. So we store this data in a eviroment variable. To achieve this we take the file and url encode it the decode it when in the app. You can do this by running something like this in node.
var fs = require('fs');
fs.readfile('yourkey.pem', function ( err, res ) {
var key = res.teString('utf8');
if ( err ) console.log( err );
console.log( encodeURIComponent( key ) );
});Then run that file. This should output the key in a format that you can store in a enviroment variable. Now add it to your .env file.
GOOGLE_KEY={the output}
GOOGLE_EMAIL={serviceaccountemail@developer.gserviceaccount.com}
GOOGLE_CALENDAR={calendarsID@group.calendar.google.com}
You will also need GOOGLE_EMAIL which can be found in the API console, and you GOOGLE_CALENDAR which is the id of the calendar you want to use for your events.
Once all thos things are settup all you need to do is share the calendar with the GOOGLE_EMAIL attached to the service account. You can do this by going to Google Calendar, clicking the small arrow next to the calendar name you would like to use, and then click share this calendar.