Last active
December 22, 2016 15:35
-
-
Save sl0ki/0507131e98a3c16c85c516da54c8982f to your computer and use it in GitHub Desktop.
API Doc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Response structure | |
#### Success response example | |
``` | |
{ | |
"status": "success", | |
"data": [ | |
{ | |
"entity_id": "1", | |
"entity_type_id": "4", | |
"attribute_set_id": "4", | |
"type_id": "simple", | |
"sku": "sdcsdc", | |
"has_options": "0", | |
"required_options": "0", | |
"created_at": "2016-12-22 15:06:34", | |
"updated_at": "2016-12-22 15:06:34" | |
} | |
] | |
} | |
``` | |
#### Error response example | |
``` | |
{ | |
"status": "error", | |
"data": null, | |
"error": "Invalid user token" | |
} | |
``` | |
## API Methods | |
> **Note:** | |
> All requests except login and register must be send with **_token** field | |
> All requests with image must be encoded as **"multipart/form-data"** | |
#### **Register User** | |
* **URL:** `/api/user/register` | |
* **Method:** `POST` | |
* **Params:** | |
- `firstname [string]` | |
- `lastname [string]` | |
- `email [string]` | |
- `password [string]` | |
*** | |
#### **Login User** | |
Login User and get access token | |
* **URL:** ` /api/user/login` | |
* **Method:** `POST` | |
* **Params:** | |
- `email [string]` | |
- `password [string]` | |
*** | |
#### **Create Config** | |
* **URL:** `/api/config/create` | |
* **Method:** `POST` | |
* **Params:** | |
- `json [string]` | |
- `image [file]` | |
*** | |
#### **Edit Config** | |
* **URL:** `/api/config/edit` | |
* **Method:** `POST` | |
* **Params:** | |
- `id [int|string]` | |
- `json [string]` | |
- `image [file]` | |
*** | |
#### **Get All Configs** | |
Get all configs record for current user | |
* **URL:** `/api/config/getList` | |
* **Method:** `GET` | |
* **Params:** no | |
*** | |
#### **Delete Config** | |
* **URL:** `/api/config/delete` | |
* **Method:** `POST` | |
* **Params:** | |
- `id [int|string]` | |
*** | |
#### **Get Products Listing** | |
* **URL:** `/api/product/getList` | |
* **Method:** `GET` | |
* **Params:** | |
*** | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment