Skip to content

Instantly share code, notes, and snippets.

@daryailyushina
Last active May 5, 2016 10:31
Show Gist options
  • Save daryailyushina/14a9949a44dfa274b263dde830d9c634 to your computer and use it in GitHub Desktop.
Save daryailyushina/14a9949a44dfa274b263dde830d9c634 to your computer and use it in GitHub Desktop.
Gopoint documentation
Title Edit user profile
Headers Content-type: application/json
X-Authorization=Bearer token
URL /api/users/
Params name
description
Data Params example
{"name":"TestName", "description":"test description"}
Method PUT
Success Response example
{"success":true}
Title Get categories
Headers Content-type: application/json
X-Authorization=Bearer token
URL /api/categories
Method GET
Success Response example
{"count":3,"limit":100,"offset":0,"data":[{"id":1,"name":"Fitness","interests":[{"id":1,"name":"Baseball"},{"id":2,"name":"Basketball"},{"id":3,"name":"Cycling"},{"id":4,"name":"Dance"},{"id":5,"name":"Extreme Sports"},{"id":6,"name":"Football"},{"id":7,"name":"Golf"},{"id":8,"name":"Gym"},{"id":9,"name":"Hiking"},{"id":10,"name":"Hockey"},{"id":11,"name":"Racquetball"},{"id":12,"name":"Running"},{"id":13,"name":"Skating"},{"id":14,"name":"Skiing"},{"id":15,"name":"Snowboarding"},{"id":16,"name":"Soccer"},{"id":17,"name":"Sports Watching"},{"id":18,"name":"Squash"},{"id":19,"name":"Surfing"},...
Title Init push notifications
Headers Content-type: application/json
X-Authorization=Bearer token
URL /api/users/push_notifications
Params pushNotifications=(1 or 0)
Data Params example
{"pushNotifications":"1"}
Method PUT
Success Response example
{"success":true}
Title Remove user avatar
Headers X-Authorization=Bearer token
URL /api/users/avatar
Method DELETE
Success Response example
{"success":true}
Title Restore passsword
Headers Content-type: application/json
URL /api/users/password
Params email
Method POST
Success Response example
{"success":true}
Title Sign in
Headers X-Authorization=Bearer token
Content-type: application/json
URL /api/login_check
Params email
password
Data Params example
{"email": "test@test.com","password":"pass"}
Method POST
Success Response example
{"token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9.eyJleHAiOjE0NjE5MjE0ODEsI...."}
Title Sign up
Headers Content-type: application/json
URL /api/users/
Params simple sign up
email
name
password
Facebook sign up
provider=facebook
token
Data Params example
simple sign up
{"email": "test@test.com","name": "name","password": "pass"}
Facebook sign up
{"provider":"facebook", "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUy......"}
Method POST
Success Response example
{"token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9.eyJleHAiOjE0NjE5MjE0ODEsI...."}
Title Add/edit user avatar
Headers X-Authorization=Bearer token
URL /api/users/avatar
Params file - multipart/form-data
Method POST
Success Response example
{"success":true}
Title Set interests
Headers X-Authorization=Bearer token
URL /api/users/interests
Params interests[]=interest id
Data Params example
interests[]=5&interests[]=7
Method PUT
Success Response example
{"success":true}
Title Verification
Headers Content-type: application/json
X-Authorization=Bearer token
URL /api/users/verification
Params verificationCode
Data Params example
{"verificationCode":"7583"}
Method POST
Success Response example
{"token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9.eyJleHAiOjE0NjE5MjE0ODEsI...."}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment