# Overview

If there are any queries or concerns, please feel free to ask or bring them up.

* [Send an email to Swoove  ](mailto:developer@swoove360.com)

### API Basics <a href="#api-basics" id="api-basics"></a>

{% hint style="info" %}
**Before you begin!**

You should create a [free Swoove account](https://business.swoove.delivery) to test the API against. We will provide you with test keys you can use to make API calls.
{% endhint %}

With the Swoove API, you can access all the features on our dashboard and expand them for use in your application. Our system is designed to be RESTful and well-organized around the primary resources you'll use, with only a few exceptions.

### HTTP Methods

* **Post**  - This request creates a new resource, such as a new estimate, delivery, etc.
* **Get -** A get request is used to retrieve data or information about a resource, such as get service zone and get delivery code.
* **Put** -To modify a resource, like updating the status of a delivery route, a put request is employed.

{% hint style="info" %}
You can use [ Postman](https://www.postman.com/downloads/) to test through our APIs to understand how they APIs work.

Postman is an easy-to-use API development and testing platform.
{% endhint %}

### Requests and Response <a href="#requests-and-response" id="requests-and-response"></a>

Both request body data and response data are formatted as JSON.&#x20;

#### <mark style="color:blue;">Response Format</mark>

```json
{
  "success": boolean,  //Only true if the details provided could be processed and no error occurred while processing
  "code": number // only numbers will be returned which represent the status code
  "message": string, //Explains why success is false... Entirely informational.
  "responses": object or array //contains actionable result of processing if present
}
```

The content type for responses will always be `application/json`.

Generally, all responses will be in the following format:

### About & API Reference

<table data-card-size="large" data-view="cards" data-full-width="true"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><a href="about">about</a></td><td><a href="about">Descriptons about swoove api</a></td><td>Description about swoove api</td><td></td><td><a href="about">about</a></td></tr><tr><td><a href="api-reference">api-reference</a></td><td><a href="api-reference">Learn more about the available endpoint in swoove open api</a></td><td></td><td></td><td></td></tr></tbody></table>

### Authentication & Errors

<table data-card-size="large" data-view="cards" data-full-width="true"><thead><tr><th data-type="content-ref"></th><th data-type="content-ref"></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><a href="authentication">authentication</a></td><td></td><td><a href="authentication">Create an API access token to authenticate your API request</a></td><td><a href="authentication">authentication</a></td></tr><tr><td><a href="errors">errors</a></td><td></td><td><a href="#errors">Learn about API errors, how they are structured and how to handle them</a></td><td><a href="errors">errors</a></td></tr></tbody></table>