Users
The user-related APIs allow you to register for an account and obtain access tokens.
Register
This API allows you to register a new account on the SuperShip system.
Endpoint
post/v1/partner/auth/register
Request
Parameters
| Field | Required | Type | Description |
|---|---|---|---|
| project | Yes | String | The name of the shop/company. For example: HMN Store. |
| name | Yes | String | The full name of the representative. For example: Hoàng Mạnh Nam. |
| phone | Yes | String | The phone number of the shop/company. For example: 0989998888. |
| Yes | String | The email of the shop/company. For example: hmn.store@gmail.com. | |
| password | Yes | String | The password. |
| partner | Yes | String | The secret code for large e-commerce partners of SuperShip. |
Example
curl --request POST \
--url https://api.mysupership.vn/v1/partner/auth/register \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"project": "HMN Store",
"name": "Hoàng Mạnh Nam",
"phone": "0989998888",
"email": "hmn.store@gmail.com",
"password": "323423",
"partner": "lPxLuxfiTotCyZ1ZnQjMepUL24HLd05ybNBhVGFN"
}'
Response
Returned Result
| Field | Type | Description |
|---|---|---|
| project | String | Name of the Shop/Company. For example: HMN Store. |
| name | String | Full name of the Representative. For example: Hoàng Mạnh Nam. |
| phone | String | Phone number of the Shop/Company. For example: 0989998888. |
| String | Email address of the Shop/Company. For example: hmn.store@gmail.com. | |
| referral | String | Referral code. For example: PLOKJ52747. |
| token_type | String | Type of Token. For example: Bearer. |
| expires_in | Integer | Time (in seconds) until the Access Token expires. For example: 31536000. |
| access_token | String | Access Token. For example: ZT2PS0pmHPHDKjRu6EMIcoM8rFM8XYHZ1Ye3zRiQ. |
Example
{
"status": "Success",
"results": {
"code": "S748146",
"project": "HMN Store",
"name": "Hoàng Mạnh Nam",
"phone": "0989998888",
"email": "hmn.store@gmail.com",
"referral": "PLOKJ52747",
"token_type": "Bearer",
"expires_in": 31536000,
"access_token": "<Access-Token>"
}
}