> For the complete documentation index, see [llms.txt](https://vick3445.gitbook.io/wbcarpool/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vick3445.gitbook.io/wbcarpool/master.md).

# WB Docs

## Getting Started

A guide on using api endpoints from the car pooling application backend.

{% hint style="warning" %}
I'm using `base_url, auth_url`or `heroku_base` on the requests screenshots.

**`base_url`**` ``=>` [`http://127.0.0.1:8000/v1/apis`](http://127.0.0.1:8000/v1/apis) 

**`auth_url`**` ``=>` [`http://127.0.0.1:8000/v1/apis/auth`](http://127.0.0.1:8000/v1/apis/auth)

**`heroku_base`**` ``=>` [`https://carpoolingbackend.herokuapp.com/v1/apis`](https://carpoolingbackend.herokuapp.com/v1/apis)
{% endhint %}

**`Documented API Endpoints.`**

| Endpoint                                                                          |                                          Function                                          |
| --------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------: |
| <ol><li><a href="/pages/-LxGqGQlpPVePiPFI7zv"><code>register</code></a></li></ol> | `Confirm user emails from WB database and automatically register them on the application.` |
| 2.[`login`](/wbcarpool/api-endpoints/login-a-user.md)                             |                              `log in users on the application`                             |
| 3. [`profile`](/wbcarpool/authentication/profile.md)                              |                         `support all operations on a user profile`                         |
| 4. [`Offer`](/wbcarpool/offer-endpoints/offer.md)                                 |                           `Make a ride offer on the application.`                          |
| 5. [`Demand`](/wbcarpool/untitled-1.md)                                           |                       `Make a demand to an offer on the application.`                      |
| 6. [`request_board`](/wbcarpool/request_board-endpoints/untitled-1.md)            |       Change the status of the demand on a trip to `accepted`, `pending` or `denied`.      |