CONFIGURATION
API KEY
binarybox_api_key_VzO8M31mfzUAW58MBuDkyVX68IWufWJWW7m5BqqSi3FSXHHwKeHjuXQzOC7QdACzffplQ93npFb6Q3sMQLeImXxkz3IHQDkWy1yt
BASE URL
https://mock-api.binaryboxtuts.com
Register and Authentication
Authenticate a user
Headers
- Accept: application/json
- Content-Type: application/json
- X-Binarybox-Api-Key: {API KEY}
Paramaters
- email [string][required]
- password [string][required]
Response
- User Object
- Token
Response Status Code
- 200 Ok - The request succeeded.
- 400 Bad Request - The request was unacceptable.
- 401 Unauthorized - The client must authenticate.
- 403 Forbidden - Invalid API Key.
- 404 Not Found - The requested resource doesn't exist.
- 422 Unprocessable Content - Semantic errors or validation errors.
- 500 Internal Server Error - Something went wrong on the server side.
Logout a user
Headers
- Accept: application/json
- Content-Type: application/json
- Authorization: Bearer {token}
- X-Binarybox-Api-Key: {API KEY}
Response
- Confirmation message
Response Status Code
- 200 Ok - The request succeeded.
- 400 Bad Request - The request was unacceptable.
- 401 Unauthorized - The client must authenticate.
- 403 Forbidden - Invalid API Key.
- 404 Not Found - The requested resource doesn't exist.
- 422 Unprocessable Content - Semantic errors or validation errors.
- 500 Internal Server Error - Something went wrong on the server side.
Register a user
Headers
- Accept: application/json
- Content-Type: application/json
- X-Binarybox-Api-Key: {API KEY}
Paramaters
- name [string][required]
- email [string][required]
- password [string][required]
- password_confirmation [string][required]
Response
- User Object
- Token
Response Status Code
- 200 Ok - The request succeeded.
- 400 Bad Request - The request was unacceptable.
- 401 Unauthorized - The client must authenticate.
- 403 Forbidden - Invalid API Key.
- 404 Not Found - The requested resource doesn't exist.
- 422 Unprocessable Content - Semantic errors or validation errors.
- 500 Internal Server Error - Something went wrong on the server side.
User (Protected)
Get the authenticate a user info
Headers
- Accept: application/json
- Content-Type: application/json
- Authorization: Bearer {token}
- X-Binarybox-Api-Key: {API KEY}
Response
- User Object
Response Status Code
- 200 Ok - The request succeeded.
- 400 Bad Request - The request was unacceptable.
- 401 Unauthorized - The client must authenticate.
- 403 Forbidden - Invalid API Key.
- 404 Not Found - The requested resource doesn't exist.
- 422 Unprocessable Content - Semantic errors or validation errors.
- 500 Internal Server Error - Something went wrong on the server side.
Project
Fetch a list of projects
Headers
- Accept: application/json
- X-Binarybox-Api-Key: {API KEY}
Parameters
- page [int][optional]
- pageSize [int][optional]
Response
- Array of Project Object
Response Status Code
- 200 Ok - The request succeeded.
- 400 Bad Request - The request was unacceptable.
- 401 Unauthorized - The client must authenticate.
- 403 Forbidden - Invalid API Key.
- 404 Not Found - The requested resource doesn't exist.
- 422 Unprocessable Content - Semantic errors or validation errors.
- 500 Internal Server Error - Something went wrong on the server side.
Find project by project ID
Headers
- Accept: application/json
- X-Binarybox-Api-Key: {API KEY}
Response
- Project Object
Response Status Code
- 200 Ok - The request succeeded.
- 400 Bad Request - The request was unacceptable.
- 401 Unauthorized - The client must authenticate.
- 403 Forbidden - Invalid API Key.
- 404 Not Found - The requested resource doesn't exist.
- 422 Unprocessable Content - Semantic errors or validation errors.
- 500 Internal Server Error - Something went wrong on the server side.
Create new project to the database
Headers
- Accept: application/json
- Content-Type: application/json
- X-Binarybox-Api-Key: {API KEY}
Parameters
- name [string][required]
- description [string][required]
Response
- Project Object
Response Status Code
- 200 Ok - The request succeeded.
- 400 Bad Request - The request was unacceptable.
- 401 Unauthorized - The client must authenticate.
- 403 Forbidden - Invalid API Key.
- 404 Not Found - The requested resource doesn't exist.
- 422 Unprocessable Content - Semantic errors or validation errors.
- 500 Internal Server Error - Something went wrong on the server side.
Update a project
Headers
- Accept: application/json
- Content-Type: application/json
- X-Binarybox-Api-Key: {API KEY}
Parameters
- name [string][required]
- description [string][required]
Response
- Project Object
Response Status Code
- 200 Ok - The request succeeded.
- 400 Bad Request - The request was unacceptable.
- 401 Unauthorized - The client must authenticate.
- 403 Forbidden - Invalid API Key.
- 404 Not Found - The requested resource doesn't exist.
- 422 Unprocessable Content - Semantic errors or validation errors.
- 500 Internal Server Error - Something went wrong on the server side.
Deletes a project
Headers
- Accept: application/json
- X-Binarybox-Api-Key: {API KEY}
Response
- Delete action message
Response Status Code
- 200 Ok - The request succeeded.
- 400 Bad Request - The request was unacceptable.
- 401 Unauthorized - The client must authenticate.
- 403 Forbidden - Invalid API Key.
- 404 Not Found - The requested resource doesn't exist.
- 422 Unprocessable Content - Semantic errors or validation errors.
- 500 Internal Server Error - Something went wrong on the server side.