API Reference
Introduction
This is the introduction section for your documentation.
It's a rich text area that will allow you to add links, headings lists, tables and more.
Base URL
Request Headers
Required headers overview if your api requires certain headers to go along with each request you should list them out here:
Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi.
- Content-Type text/html; charset=UTF-8
- Transfer-Encoding chunked
- Connection keep-alive
- Content-Encoding gzip
- Accept application/json
Error Handling
Error codes overview this is a great place to tell your users how to handle error responses as well as the structure for errors.
Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.
- 400 - Bad Request The request was unacceptable, often due to missing a required parameter.
- 401 - Unauthorized No valid API key provided.
- 402 - Request Failed The parameters were valid but the request failed.
- 403 - Forbidden The API key doesn't have permissions to perform the request.
- 404 - Not Found The requested resource doesn't exist.
- 409 - Conflict The request conflicts with another request (perhaps due to using the same idempotent key).
- 429 - Too Many Requests Too many requests hit the API too quickly, see rate limit section
- 500, 502, 503, 504 - Server Errors Something went wrong on our end
Meta Data
Reference objects overview let your users know about any response particles that are reused throughout your system, for example pagination, search filters, and modifiers that are always available such as created_at, id, updated_at
Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
- Aliquam tincidunt mauris eu risus.
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
- Aliquam tincidunt mauris eu risus.
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
- Aliquam tincidunt mauris eu risus.
Pagination
Global pagination overview, if your api components share a pagination system ( as most would ) you should detail it here so users can have a point of reference. You can also add a codeblock to provide an example of the return response.
{
"total": 50,
"per_page": 15,
"current_page": 1,
"last_page": 4,
"first_page_url": "https://domain.?page=1",
"last_page_url": "https://doman.com?page=4",
"next_page_url": "https://domain.com?page=2",
"prev_page_url": null,
"path": "http://laravel.app",
"from": 1,
"to": 15,
"data": [
{
// Record...
},
{
// Record...
}
]
}
Deprecation
Endpoint / Deprecation overview: Give your users a bit of information on your deprecation process, details such as support timeline and dates are always good.
Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
- Aliquam tincidunt mauris eu risus.
Authentication
Authentication process overview use this space to write up a description about the authentication methods available in your api, and how it will be used to authenticate going forward, for example if you use Oauth you could tell users that they need to send the Authorization header with the bearer token, also explain how they can scroll down for details on the authentication endpoints.
"Authorization: Bearer xxx"
Login
Detail your login endpoint here, senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper.
Request Limit: 5
Body Parameters
Example Request
{
"email": "email@domain.com",
"password": "password"
}Example Response
{
"message": "User successfully logged in",
"expires_in": 3600,
"token_type": "bearer",
"access_token": "wuihb5...."
}Registration
Detail your registration endpoint here, senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper.
Request Limit: 5
Body Parameters
Example Request
{
"email": "email@domain.com",
"password": "password",
"last_name": "Last Name",
"first_name": "First Name",
"password_confirmation": "password"
}Example Response
{
"message": "User successfully registered",
"expires_in": 3600,
"token_type": "bearer",
"access_token": "wuihb5...."
}Logout
Detail your logout endpoint here, senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper.
Request Limit: 5
Example Request
[]
Example Response
{
"message": "User successfully logged out"
}Verify Email
Detail your email verification endpoint here, senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper.
Request Limit: 5
URL Parameters
Example Request
[]
Example Response
{
"message": "User successfully verified"
}Token Refresh
Detail your token refresh endpoint here, senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper.
Request Limit: 5
Example Request
[]
Example Response
{
"expires_in": 3600,
"token_type": "bearer",
"access_token": "wuihb5...."
}Reset Password
Detail your reset password endpoint here, senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper.
Request Limit: 5
Body Parameters
Example Request
{
"token": "resetpasswordtoken",
"password": "password",
"password_confirmation": "password"
}Example Response
{
"message": "Password successfully reset"
}Et Exercitationem
Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.
Second Header
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
- Aliquam tincidunt mauris eu risus.
- Aliquam tincidunt mauris eu risus.
Blanditiis assumenda voluptatum.
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
- Aliquam tincidunt mauris eu risus.
Voluptatem occaecati illum illo.
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
- Aliquam tincidunt mauris eu risus.
Dolorem Sit
Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.
Second Header
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
- Aliquam tincidunt mauris eu risus.
- Aliquam tincidunt mauris eu risus.
URL Parameters
Example Request
[]
Example Response
[]
Ipsam Qui
Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.
Second Header
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
- Aliquam tincidunt mauris eu risus.
- Aliquam tincidunt mauris eu risus.
Body Parameters
Example Request
[]
Example Response
[]
Aut Et
Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.
Second Header
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
- Aliquam tincidunt mauris eu risus.
- Aliquam tincidunt mauris eu risus.
Body Parameters
Example Request
[]
Example Response
[]
Dolores Nostrum
Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.
Second Header
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
- Aliquam tincidunt mauris eu risus.
- Aliquam tincidunt mauris eu risus.
Body Parameters
Example Request
[]
Example Response
[]
Reiciendis Ullam
Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.
Second Header
- Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
- Aliquam tincidunt mauris eu risus.
- Aliquam tincidunt mauris eu risus.
URL Parameters
Example Request
[]
Example Response
[]