No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
src
test
.babelrc
.editorconfig
.eslintignore
.eslintrc
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
car.jpg
package.json

README.md

Scape

Scape


Website   website   Getting Started   getting-started   Docs   docs


Methods

Method HTTP Method Route Description Params (Bold = optional) Response
DevOps
-- GET /api/v1/_healthcheck Returns {'status':'ok'} if healthy -- { 'status': 'ok' }
Auth
.authCheck() GET /api/v1/auth Returns {'auth': true} if auth -- { 'auth': true }
.login(email, password) POST /api/v1/auth/login Login {email: 'anthonybudd@ideea.co.uk', password: 'password'} {access_token}
.forgotPassword(email) POST /api/v1/auth/forgot Forgot Password {email: 'anthonybudd@ideea.co.uk' } { 'success': 'true' }
.resetPassword(resetRequest) POST /api/v1/auth/reset Update User's Password {email: 'anthonybudd@ideea.co.uk',password: 'new_password',password_reset_key: '98e3bc7es2u8saf'} {access_token}
.signUp(user) POST /api/v1/auth/sign-up Sign up {email: 'anthonybudd@ideea.co.uk',password: 'new_password',first_name: 'Anthony',last_name: 'Budd',group_name: 'Ideea Technologies'} {access_token}
.validateEmailAddress(validationKey) GET /api/v1/auth/validate Validates an Email address { redirect: 0 } Redirect /account
.signUpByInviteKey(user) POST /api/v1/auth/sign-up-by-invite-key Complete invitation {email: 'anthonybudd@ideea.co.uk',password: 'new_password',invite_key: '98e3bc7es2u8saf'} {access_token}
Groups
.getGroup(groupID) GET /api/v1/groups/{group_id} Returns current group -- {Group}
.updateGroup(groupID, group) POST /api/v1/groups/{group_id} Update group {name: 'Ideea' } {Group}
.getGroupUsers(groupID) GET /api/v1/groups/{group_id}/users Returns the group's users -- [User, User...]
.addUserToGroup(groupID, userID, role) POST /api/v1/groups/{group_id}/users/add Add user to group {user_id: '', role: 'user' } { 'success': true }
.removeUserFromGroup(groupID, userID) POST /api/v1/groups/{group_id}/users/remove Remove user from group {user_id: '' } { 'success': true }
.inviteUser(groupID, user) POST /api/v1/groups/{group_id}/users/invite Invites user to group {email: 'anthonybudd@ideea.co.uk',first_name: 'anthony',last_name: 'budd'} {User}
.getCharges(groupID) GET /api/v1/groups/{group_id}/charges Get a group's charges -- [Charge, Charge...]
.getCharge(groupID, chargeID) GET /api/v1/groups/{group_id}/charges/{charge_id} Get a single charges -- {Charge}
Cards
.getCards(groupID) GET /api/v1/groups/{group_id}/cards Returns the current group's cards -- [Card, Card]
.addCard(groupID, token) POST /api/v1/groups/{group_id}/cards/new Create a new card {token: 'tok_xxxxxxxxxxx'} {Card}
.setDefaultCard(groupID, cardID) POST /api/v1/groups/{group_id}/cards/{card_id}/default Set ddefault card -- { 'success': true' }
.deleteCard(groupID, cardID) DEL /api/v1/groups/{group_id}/cards/{card_id}/delete Delete a card -- { 'success': true' }
Tokens
.getApiKeys(groupID, apiKey) GET /api/v1/groups/{group_id}/tokens Returns the groups tokens -- [Token, Token..]
.createApiKey(groupID, apiKey) POST /api/v1/groups/{group_id}/tokens/create Creates a new token -- {Token}
.createEphemeralKey(groupID) POST /api/v1/groups/{group_id}/tokens/create/ephemeral Creates a new ephemeral token -- {Token}
.createOneTimeUseKey(groupID POST /api/v1/groups/{group_id}/tokens/create/one-time ) Creates a new one-time use token -- {Token}
.deleteApiKey(groupID, apiKeyID) DEL /api/v1/groups/{group_id}/tokens/{token_id}/delete Deletes a token -- { 'success': true }
User
.getUser() GET /api/v1/user Get the current user -- {User}
.getUserByInviteKey(inviteKey) GET /api/v1/user/by-invite-key/{invite_key} Get user by invite key -- {User}
.updateUser(user) POST /api/v1/user Update the current user {first_name: 'Ant', last_name: 'B',display_name: 'Anthony.B'} {User}
.updatePassword(oldPassword, newPassword) POST /api/v1/user/update-password Update the current users password {oldPassword: 'password', newPassword: 'newpassword123'} { 'success': true }
-- GET /api/v1/user/profile-image/{name} Get a profile image -- PNG Image

© Ideea x Anthony Budd