DOCS.md

car-care v0.0.0

• Auth

  • Authenticate

• PasswordReset

  • Send email
  • Submit password
  • Verify token

• User

  • Create user
  • Delete user
  • Retrieve current user
  • Retrieve user
  • Retrieve users
  • Update password
  • Update user

Auth

Authenticate

POST /auth

Headers

Name	Type	Description
Authorization	String	Basic authorization with email and password.

Parameters

Name	Type	Description
access_token	String	Master access_token.

PasswordReset

Send email

POST /password-resets

Parameters

Name	Type	Description
email	String	Email address to receive the password reset token.
link	String	Link to redirect user.

Submit password

PUT /password-resets/:token

Parameters

Name	Type	Description
password	String	User's new password.

Verify token

GET /password-resets/:token

User

Create user

POST /users

Parameters

Name	Type	Description
access_token	String	Master access_token.
email	String	User's email.
password	String	User's password.
name	String	optional User's name.
picture	String	optional User's picture.
role	String	optional User's role.

Delete user

DELETE /users/:id

Parameters

Name	Type	Description
access_token	String	User access_token.

Retrieve current user

GET /users/me

Parameters

Name	Type	Description
access_token	String	User access_token.

Retrieve user

GET /users/:id

Retrieve users

GET /users

Parameters

Name	Type	Description
access_token	String	User access_token.
q	String	optional Query to search.
page	Number	optional Page number.
limit	Number	optional Amount of returned items.
sort	String[]	optional Order of returned items.
fields	String[]	optional Fields to be returned.

Update password

PUT /users/:id/password

Headers

Name	Type	Description
Authorization	String	Basic authorization with email and password.

Parameters

Name	Type	Description
password	String	User's new password.

Update user

PUT /users/:id

Parameters

Name	Type	Description
access_token	String	User access_token.
name	String	optional User's name.
picture	String	optional User's picture.