# Splash Page API

## Lấy danh sách trang chào

<mark style="color:blue;">`GET`</mark> `{{base_url}}/splash_pages`

Cho phép lấy danh sách trang chào của một địa điểm

#### Query Parameters

| Name       | Type   | Description                                                                                                                                                                |
| ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| pos\_id    | string | id địa điểm                                                                                                                                                                |
| type\_page | string | Loại trang chào. Nếu truyền vào type\_page sẽ lấy ra chi tiết thông tin của loại trang chào đó , nếu không truyền vào type\_page sẽ lấy ra danh sách tất cả các trang chào |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |

{% tabs %}
{% tab title="200 Lấy ra danh sách trang chào" %}

```javascript
{
    "status": 200,
    "message": "List splash pages",
    "data": [

    ]
}
```

{% endtab %}

{% tab title="401 access\_token không tồn tại" %}

```javascript
{
    "status_code": 401,
    "message": "access_token not found! Please contact Nextify at support@nextify.vn for help"
}
```

{% endtab %}

{% tab title="404 pos\_id không tồn tại" %}

```
{
    "status": 404,
    "status_code": 404,
    "message": "pos_id does not exist!"
}
```

{% endtab %}
{% endtabs %}

| Tên                         | Type\_page |
| --------------------------- | ---------- |
| Trang đăng ký               | register   |
| Trang chào mặc định         | default    |
| Chúc mừng sinh nhật         | birthday   |
| Trang chào theo lượt đến    | loyal      |
| Trang chào theo tag         | tag        |
| Trang chào theo khung giờ   | hour       |
| Trang chào theo khoảng ngày | promotion  |
| Trang khảo sát              | survey     |

```javascript
curl -X GET \
  '{{ base_url }}/splash_pages?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}'

```

## Tạo mới trang chào mặc định

<mark style="color:green;">`POST`</mark> `{{base_url}}/splash_pages/default`

Cho phép tạo mới trang chào mặc định

#### Query Parameters

| Name    | Type   | Description |
| ------- | ------ | ----------- |
| pos\_id | string | id địa điểm |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |
| Content-Type  | string | multipart/form-data     |

#### Request Body

| Name                        | Type   | Description                                        |
| --------------------------- | ------ | -------------------------------------------------- |
| hotspot\_method             | string | Hình thức hotspot ( profile\_code or default )     |
| photo                       | string | Ảnh trang chào                                     |
| content                     | string | Nội dung ảnh                                       |
| title                       | string | Tiêu đề ảnh                                        |
| auto\_popup                 | string | Trang popup tự động chuyển hướng sau khi đăng nhập |
| welcome\_text               | string | Lời chào khi kết nối WIFI                          |
| connect\_button             | string | Tên nút kết nối WIFI                               |
| ignore\_register            | string | Bỏ qua đăng ký ("True" or "False")                 |
| wifi\_access\_code\_default | string | Mã truy cập wifi mặc định                          |
| facebook\_pixel\_id         | string | Pixel ID                                           |
| facebook\_pixel\_code       | string | Pixel code                                         |
| google\_pixel\_code         | string | Google remarketing code                            |

{% tabs %}
{% tab title="200 Tạo mới thành công trang chào" %}

```
{
    "status": 200,
    "status_code": 200,
    "message": "Success!"
}
```

{% endtab %}

{% tab title="400 Sai dữ liệu truyền vào" %}

```
{
    "status": 400,
    "status_code": 400,
    "message": "Wrong data!"
}
```

{% endtab %}

{% tab title="401 access\_token không tồn tại" %}

```
{
    "status_code": 401,
    "message": "access_token not found! Please contact Nextify at support@nextify.vn for help"
}
```

{% endtab %}

{% tab title="404 pos\_id không tồn tại" %}

```
{
    "status": 404,
    "status_code": 404,
    "message": "pos_id does not exist!"
}
```

{% endtab %}
{% endtabs %}

```javascript
curl -X POST \
  '{{ base_url }}/splash_pages/default?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}' \
  -H 'Content-Type: multipart/form-data' \
  -F photo=@{{ photo_path }} \
  -F content={{ content }} \
  -F title={{ title }} \
  -F auto_popup=https://www.facebook.com/nextifyvn/ \
  -F welcome_text=Hello \
  -F connect_button=connect \
  -F ignore_register=False
```

| hotspot\_method ( Hình thức hotspot ) | giải thích |
| ------------------------------------- | ---------- |
| profile\_code                         |            |
| default                               |            |

## Cấu hình trang chào đăng ký

<mark style="color:green;">`POST`</mark> `{{base_url}}/splash_pages/register`

Cho phép cấu hình trang chào đăng ký

#### Query Parameters

| Name    | Type   | Description |
| ------- | ------ | ----------- |
| pos\_id | string | id địa điểm |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |
| Content-Type  | string | application/json        |

#### Request Body

| Name                    | Type   | Description                                                                  |
| ----------------------- | ------ | ---------------------------------------------------------------------------- |
| hotspot\_method         | string | Hình thức hotspot ( profile\_code or default )                               |
| default\_code           | string | Mã truy cập wifi mặc định                                                    |
| name                    | string | Cấu hình trang đăng ký có yêu cầu họ và tên hay không, "True" or "False"     |
| name\_require           | string | Bắt buộc người dùng phải nhập họ và tên hay có thể bỏ qua, "True" or "False" |
| email                   | string | Cấu hình trang đăng ký có yêu cầu email hay không, "True" or " False"        |
| email\_require          | string | Bắt buộc người dùng phải nhập email hay có thể bỏ qua, "True" or "False"     |
| birthday                | string | Cấu hình trang đăng ký có yêu cầu ng sinh hay không, "True" or "False"       |
| birthday\_require       | string | Bắt buộc người dùng phải nhập ngày sinh hay có thể bỏ qua, "True" or "False" |
| year\_birthday          | string | Cấu hình trang đăng ký có yêu cầu năm sinh hay không, "True" or "False"      |
| year\_birthday\_require | string | Bắt buộc người dùng phải nhập năm sinh hay có thể bỏ qua, "True" or "False"  |
| gender                  | string | Cấu hình trang đăng ký có yêu cầu giới tính hay không, "True" or "False"     |
| gender\_require         | string | Bắt buộc người dùng phải nhập giới tính hay có thể bỏ qua, "True" or "False" |
| welcome\_text           | string | Lời chào mời đăng ký                                                         |
| birthday\_text          | string | Lời chào mời nhập sinh nhật                                                  |
| welcome\_button         | string | Tên nút kết nối                                                              |
| otp                     | string | Sử dụng otp khi đăng ký, "True" or "False"                                   |

{% tabs %}
{% tab title="200 Cấu hình thành công" %}

```
{
    "status": 200,
    "status_code": 200,
    "message": "Success!"
}
```

{% endtab %}

{% tab title="400 Sai dữ liệu truyền vào" %}

```
{
    "status": 400,
    "status_code": 400,
    "message": "Wrong data!"
}
```

{% endtab %}

{% tab title="401 access\_token không tồn tại" %}

```
{
    "status_code": 401,
    "message": "access_token not found! Please contact Nextify at support@nextify.vn for help"
}
```

{% endtab %}

{% tab title="404 pos\_id không tồn tại" %}

```
{
    "status": 404,
    "status_code": 404,
    "message": "pos_id does not exist!"
}
```

{% endtab %}
{% endtabs %}

```javascript
curl -X POST \
  '{{ base_url }}/splash_pages/register?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}' \
  -H 'Content-Type: application/json' \
  -d '{
	"name": "False",
	"name_require": "False",
	"email": "False",
	"email_require": "False",
	"birthday": "False",
	"birthday_require": "False",
	"year_birthday": "False",
	"year_birthday_require": "False",
	"gender": "False",
	"gender_require": "False",
	"welcome_text": "HELLO",
	"birthday_text": "Moi ban Nhap Vao Ngay sinh",
	"welcome_button": "Connect",
	"otp": "True"
}'
```

## Lấy chi tiết thông tin trang chào của shop

<mark style="color:blue;">`GET`</mark> `{{base_url}}/splash_pages/<type_page>`

Cho phép lấy chi tiết thông tin trang chào

#### Query Parameters

| Name    | Type   | Description |
| ------- | ------ | ----------- |
| pos\_id | string | id địa điểm |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

```javascript
curl -X GET \
  '{{ base_url }}/splash_pages/{{ type_page }}?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}'
```

| Loại trang chào                 | type\_page |
| ------------------------------- | ---------- |
| Trang chào theo khoảng ngày     | promotion  |
| Trang chào theo giờ             | hour       |
| Trang chào khảo sát             | survey     |
| Trang chào sinh nhật            | birthday   |
| Trang chào theo lượt đến        | loyal      |
| Trng chào theo tag              | tag        |
| Trang chào mặc định             | default    |
| Trang đăng ký                   | register   |
| Trang chào theo ngày trong tuần | weekday    |

## Xóa ảnh trong trang chào mặc định

<mark style="color:red;">`DELETE`</mark> `{{base_url}}/splash_pages/default`

Cho phép xóa ảnh trong trang chào mặc định

#### Query Parameters

| Name    | Type   | Description |
| ------- | ------ | ----------- |
| pos\_id | string | id địa điểm |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |
| Content-Type  | string | multipart/form-data     |

#### Request Body

| Name     | Type   | Description       |
| -------- | ------ | ----------------- |
| card\_id | string | id ảnh trang chào |

{% tabs %}
{% tab title="200 Xóa ảnh thành công" %}

```
{
    "status": 200,
    "message": [
        {
            "message": "Detele success!",
            "card_id": "5d960c99a066db1615fbbf40",
            "isError": false
        },
        {
            "message": "Card does not exist!",
            "card_id": "5d960c99a066db1615fbbf3e",
            "isError": true
        }
    ]
}
```

{% endtab %}

{% tab title="400 key phải là card\_id" %}

```
{
    "status": 400,
    "message": "key must be card_id"
}
```

{% endtab %}

{% tab title="404 pos\_id không tồn tại" %}

```
{
    "status_code": "404",
    "message": "pos_id does not exist!"
}
```

{% endtab %}
{% endtabs %}

```javascript
curl -X DELETE \
  '{{ base_url }}/splash_pages/default?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ card_id }}' \
  -H 'Content-Type: multipart/form-data' \
  -F card_id={{ card_id }}
```

## Update ảnh trang chào mặc định

<mark style="color:orange;">`PUT`</mark> `{{base_url}}/splash_pages/default/card`

Cho phép update ảnh trang chào mặc định

#### Query Parameters

| Name     | Type   | Description |
| -------- | ------ | ----------- |
| pos\_id  | string | id địa điểm |
| card\_id | string | id ảnh      |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |
| Content-Type  | string | multipart/form-data     |

#### Request Body

| Name    | Type   | Description    |
| ------- | ------ | -------------- |
| photo   | string | Ảnh trang chào |
| content | string | Nội dung ảnh   |
| title   | string | Tiêu đề ảnh    |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

```javascript
curl -X PUT \
  '{{ base_url }}/splash_pages/default/card?pos_id={{ pos_id }}&card_id={{ card_id }}' \
  -H 'Authorization: Bearer {{ access_token }}' \
  -H 'Content-Type: multipart/form-data' \
  -F photo=@{{ photo_path }} \
  -F content={{ content }} \
  -F title={{ title }}
```

## Tạo và chỉnh sửa trang chào theo khoảng ngày

<mark style="color:green;">`POST`</mark> `{{ base_url }}/splash_pages/promotion`

Cho phép tạo mới và chỉnh sửa trang chào theo khoảng ngày

#### Query Parameters

| Name       | Type   | Description                                                                                                                                                                                                       |
| ---------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| pos\_id    | string | id địa điểm                                                                                                                                                                                                       |
| splash\_id | string | id trang chào ( trường hợp không truyền vào sẽ tạo mới trang chào, nếu truyền vào sẽ update thông tin ) ( lấy id trong trường "\_id" , url: "{{ base\_url }}/splash\_pages?pos\_id=abcdef\&type\_page=promotion") |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |
| Content-Type  | string | multipart/form-data     |

#### Request Body

| Name            | Type   | Description                                            |
| --------------- | ------ | ------------------------------------------------------ |
| hotspot\_method | string | Hình thức hotspot (profile\_code or default)           |
| default\_code   | string | Mã truy cập wifi mặc định                              |
| auto\_pop       | string | Trang popup tự động chuyển hướng sau đăng nhập         |
| photo           | string | ảnh nền trang chào                                     |
| title           | string | Lời chào                                               |
| content         | string | Nội dung                                               |
| date\_from      | string | ngày bắt đầu ( fomat : "dd-mm-yyyy" ,vd: "04-10-2019") |
| date\_to        | string | ngày kết thúc ( fomat: "dd-mm-yyyy",vd: "05-10-2019")  |
| active          | string | trạng thái kích hoạt ( ví dụ : "True" hoặc "False")    |

{% tabs %}
{% tab title="200 " %}

```javascript
{
    "status": 200,
    "message": "Success!"
}
```

{% endtab %}

{% tab title="400 " %}

```javascript
{
    "status": 400,
    "message": "invalid period!"
}
```

{% endtab %}

{% tab title="401 " %}

```javascript
{
    "status_code": "401",
    "message": "access_token not found! Please contact Nextify at support@nextify.vn for help"
}
```

{% endtab %}
{% endtabs %}

```javascript
curl -X POST \
  '{{ base_url }}/splash_pages/promotion?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}' \
  -H 'Content-Type: multipart/form-data' \
  -F auto_popup=https://www.facebook.com/nextifyvn/ \
  -F photo=@{{ photo_path }} \
  -F title={{ title }} \
  -F content={{ content }} \
  -F date_from=04-10-2019 \
  -F date_to=05-10-2019 \
  -F active=False
```

## Tạo mới và chỉnh sửa trang chào theo tag khách hàng

<mark style="color:green;">`POST`</mark> `{{ base_url }}/splash_pages/tag`

cho phép tạo mối và chỉnh sửa trang chào theo tag khách hàng

#### Query Parameters

| Name       | Type   | Description                                                                                                             |
| ---------- | ------ | ----------------------------------------------------------------------------------------------------------------------- |
| pos\_id    | string | id địa điểm                                                                                                             |
| splash\_id | string | id trang chào ( nếu không có dữ liệu truyền vào sẽ tạo mới trang và nếu có thì sẽ update thông tin trang chào có id đó) |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |
| Content-Type  | string | multipart/form-data     |

#### Request Body

| Name            | Type   | Description                                          |
| --------------- | ------ | ---------------------------------------------------- |
| hotspot\_method | string | Hình thức hotspot (profile\_code or default)         |
| default\_code   | string | Mã truy cập wifi mặc định                            |
| photo           | string | ảnh nền trang chào                                   |
| title           | string | lời chào                                             |
| content         | string | nội dung                                             |
| auto\_popup     | string | trang popup tự động chuyển hướng sau xem trang chào  |
| active          | string | trạng thái trang chào ( ví dụ : "True" hoặc "False") |
| tags            | string | id các tag hiện có của chi nhánh, địa điểm           |

{% tabs %}
{% tab title="200 Thao tác thành công" %}

```javascript
{
    "status": 200,
    "message": "Success!"
}
```

{% endtab %}

{% tab title="400 sai dữ liệu truyền vào " %}

```javascript
{
    "status": 400,
    "message": "Tags must be List, Please contact Nextify at support@nextify.vn for help!"
}
```

{% endtab %}
{% endtabs %}

```javascript
curl -X POST \
  '{{ base_url }}/splash_pages/tag?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}' \
  -H 'Content-Type: multipart/form-data' \
  -F photo=@{{ photo_path }} \
  -F tags={{ tag_id }} \
  -F tags={{ tag_id }} \
  -F title={{ title }} \
  -F content={{ content }} \
  -F auto_popup={{ auto_popup }}
```

## Tạo mới và chỉnh sửa trang chào theo lượt đến

<mark style="color:green;">`POST`</mark> `{{ base_url }}/splash_pages/loyal`

Cho phép tạo mới và chỉnh sửa trang chào theo lượt đến

#### Query Parameters

| Name       | Type   | Description                                                                                             |
| ---------- | ------ | ------------------------------------------------------------------------------------------------------- |
| pos\_id    | string | id địa điểm                                                                                             |
| splash\_id | string | id trang chào ( trường hợp truyền vào sẽ là update thông tin, nếu không truyền vào sẽ là tạo trang mới) |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |
| Content-Type  | string | multipart/form-data     |

#### Request Body

| Name              | Type   | Description                                                            |
| ----------------- | ------ | ---------------------------------------------------------------------- |
| default\_code     | string | Mã truy cập wifi mặc định                                              |
| hotspot\_method   | string | Hình thức hotspot (profile\_code or default)                           |
| photo             | string | ảnh nền trang chào                                                     |
| visit\_by         | string | số lượt đến tính theo ( "shop" hoặc "merchant"), mặc định là theo shop |
| title             | string | lời chào                                                               |
| content           | string | nội dung                                                               |
| loyal\_count      | string | lượt đến giới hạn dưới                                                 |
| loyal\_count\_max | string | lượt đến giới hạn trên                                                 |
| active            | string | trạng thái kích hoạt trang chào (vd : "True" hoặc "False"              |
| auto\_popup       | string | trang popup tự động chuyển hướng sau xem trang chào                    |

{% tabs %}
{% tab title="200 thao tác thành công" %}

```javascript
{
    "status": 200,
    "message": "Success!"
}
```

{% endtab %}

{% tab title="400 data truyền vào không đúng" %}

```javascript
{
    "status": 400,
    "message": "loyal_count, loyal_count_max is wrong!"
}
```

{% endtab %}
{% endtabs %}

```javascript
curl -X POST \
  '{{ base_url }}/splash_pages/loyal?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}' \
  -H 'Content-Type: multipart/form-data' \
  -F photo=@{{ photo_path }} \
  -F title={{ title }} \
  -F content={{ content }} \
  -F loyal_count=1 \
  -F auto_popup=https://www.facebook.com/nextifyvn/ \
  -F active=true \
  -F loyal_count_max=10 \
  -F visit_by=shop
```

## Tạo mới và chỉnh sửa trang chào theo ngày trong tuần&#x20;

<mark style="color:green;">`POST`</mark> `{{ base_url }}/splash_pages/weekday`

Cho phép tạo mới và chỉnh sửa trang chào theo ngày trong tuần

#### Query Parameters

| Name       | Type   | Description                                                                                                   |
| ---------- | ------ | ------------------------------------------------------------------------------------------------------------- |
| pos\_id    | string | id địa điểm                                                                                                   |
| splash\_id | string | id trang chào ( trường hợp truyền vào sẽ update thông tin trang chào, nếu không truyền vào sẽ tạo trang mới ) |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |
| Content-Type  | string | multipart/form-data     |

#### Request Body

| Name            | Type   | Description                                                                                                                 |
| --------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- |
| hotspot\_method | string | Hình thức hotspot (profile\_code or default)                                                                                |
| default\_code   | string | Mã truy cập wifi mặc định                                                                                                   |
| weekday         | string | ngày trong tuần, chọn trong danh sách sau : 'monday', 'tuesday',  'wednesday', 'thursday', 'friday', 'saturday', 'sunday' . |
| active          | string | Trạng thái kích hoạt trang chào (vd : 'True' hoặc 'False')                                                                  |
| photo           | string | ảnh trang chào                                                                                                              |
| title           | string | Tiêu đề                                                                                                                     |
| content         | string | Nội dung trang chào                                                                                                         |
| auto\_popup     | string | Trang chuyển hướng sau đăng nhập                                                                                            |

{% tabs %}
{% tab title="200 Thao tác thành công" %}

```javascript
{
    "status": 200,
    "message": "Success!"
}
```

{% endtab %}

{% tab title="400 " %}

```javascript
{
    "status": 400,
    "message": "weekday is required, you can choice in: 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'"
}
```

{% endtab %}
{% endtabs %}

```javascript
curl -X POST \
  '{{ base_url }}/splash_pages/weekday?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}' \
  -H 'Content-Type: multipart/form-data' \
  -F photo=@{{ photo_path }} \
  -F title={{ title }} \
  -F 'content=Bạn nghĩ gì về dịch vụ của chúng tôi' \
  -F auto_popup=https://www.facebook.com/nextifyvn/ \
  -F active=true \
  -F weekday=monday
```

## Tạo mới và chỉnh sửa trang chào theo giờ

<mark style="color:green;">`POST`</mark> `{{ base_url }}/splash_pages/hour`

Cho phép tạo mới và chỉnh sửa thông tin trang chào theo giờ

#### Query Parameters

| Name       | Type   | Description                                                                                                                                                                            |
| ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| pos\_id    | string | id địa điểm                                                                                                                                                                            |
| splash\_id | string | id trang chào ( trường hợp không truyền vào sẽ tạo mới trang chào, nếu truyền vào sẽ  chỉnh sửa thông tin trang chào) ( lấy ở trường "\_id" info\_page, API lấy danh sách trang chào ) |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |
| Content-Type  | string | multipart/form-data     |

#### Request Body

| Name            | Type   | Description                                                   |
| --------------- | ------ | ------------------------------------------------------------- |
| hotspot\_method | string | Hình thức hotspot (profile\_code or default)                  |
| default\_code   | string | Mã truy cập wifi mặc định                                     |
| active          | string | trạng thái kích hoạt trang chào  ( ví dụ "True" hoặc "False") |
| title           | string | lời chào                                                      |
| photo           | string | ảnh nền trang chào                                            |
| content         | string | nội dung                                                      |
| hour\_to        | string | giờ kết thúc ( fomat: "hh:ii", vd: "12:20")                   |
| hour\_from      | string | giờ bắt đầu (fomat: "hh:ii", vd: "11:20")                     |
| auto\_popup     | string | trang popup tự động chuyên hướng sau đăng nhập                |

{% tabs %}
{% tab title="200 thao tác thành công" %}

```javascript
{
    "status": 200,
    "message": "Success!"
}
```

{% endtab %}

{% tab title="400 data truyền vào không đúng" %}

```javascript
{
    "status": 400,
    "message": "invalid period!"
}
```

{% endtab %}
{% endtabs %}

```javascript
curl -X POST \
  '{{ base_url }}/splash_pages/hour?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}' \
  -H 'Content-Type: multipart/form-data' \
  -F photo=@{{ photo_path }} \
  -F title={{ title }} \
  -F 'content=Bạn nghĩ gì về dịch vụ của chúng tôi' \
  -F hour_to=13:00 \
  -F auto_popup=https://www.facebook.com/nextifyvn/ \
  -F active=true \
  -F hour_from=11:00
```

## Tạo mới trang chào chúc mừng sinh nhật&#x20;

<mark style="color:green;">`POST`</mark> `{{base_url}}/splash_pages/birthday`

Cho phép tạo mới và chỉnh sửa trang chào đăng kí

#### Query Parameters

| Name    | Type   | Description |
| ------- | ------ | ----------- |
| pos\_id | string | id địa điểm |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |
| Content-Type  | string | multipart/form-data     |

#### Request Body

| Name            | Type   | Description                                    |
| --------------- | ------ | ---------------------------------------------- |
| hostpot\_method | string | Hình thức hotspot (profile\_code or default)   |
| default\_code   | string | Mã truy cập wifi mặc định                      |
| photo           | string | Ảnh nền trang chào                             |
| title           | string | Tiêu đề                                        |
| content         | string | Nội dung                                       |
| auto\_popup     | string | Trang popup tự động chuyển hướng sau đăng nhập |
| active          | string | kích hoạt (True or False)                      |

{% tabs %}
{% tab title="200 Tạo mới trang chào thành công" %}

```
{
    "status": 200,
    "message": "success",
    "data": {
    
    }
}
```

{% endtab %}
{% endtabs %}

```javascript
curl -X POST \
  '{{ base_url }}/splash_pages/birthday?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}' \
  -H 'Content-Type: multipart/form-data' \
  -F photo=@{{ photo_path }} \
  -F title={{ title }} \
  -F 'content={{ content }}' \
  -F auto_popup={{ auto_popup }} \
  -F active=true
```

## Tạo mới trang chào khảo sát

<mark style="color:green;">`POST`</mark> `{{base_url}}/splash_pages/survey`

Cho phép tạo mới và chỉnh sửa trang chào khảo sát

#### Query Parameters

| Name    | Type   | Description |
| ------- | ------ | ----------- |
| pos\_id | string | id địa điểm |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |
| Content-Type  | string | multipart/form-data     |

#### Request Body

| Name            | Type   | Description                                  |
| --------------- | ------ | -------------------------------------------- |
| hostpot\_method | string | Hình thức hotspot (profile\_code or default) |
| default\_code   | string | Mã truy cập wifi mặc định                    |
| photo           | string | Ảnh nền trang chào                           |
| survey\_type    | string | Loại khảo sát                                |
| question        | string | Câu hỏi                                      |
| answer          | string | Câu trả lời                                  |
| auto\_popup     | string | Trang chuyển hướng sau đăng nhập             |
| active          | string | Kích hoạt (True or False)                    |
| min\_point      | string | Điểm thấp nhất                               |
| max\_point      | string | Điểm nhiều nhất                              |

{% tabs %}
{% tab title="200 Tạo mới thành công" %}

```javascript
{
    "status": 200,
    "message": "Success!"
}
```

{% endtab %}
{% endtabs %}

| Loại khảo sát     | survey\_type  | Mô tả                                          |
| ----------------- | ------------- | ---------------------------------------------- |
| Chọn nhiều đáp án | multi\_select | Bắt buộc phải có trường answer                 |
| Chọn một đáp án   | one\_select   | Bắt buộc phải có trường answer                 |
| Chấm điểm         | rating        | Bắt buộc phải có trường min\_point, max\_point |

```javascript
# survey_type: rating
curl -X POST \
  '{{ base_url }}/splash_pages/survey?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}' \
  -H 'Content-Type: multipart/form-data' \
  -F photo=@{{ photo_path }} \
  -F survey_type=rating \
  -F 'question=Bạn nghĩ gì về dịch vụ của chúng tôi' \
  -F auto_popup=https://www.facebook.com/nextifyvn/ \
  -F active=true \
  -F min_point=1 \
  -F max_point=5

# survey_type: multi_select
curl -X POST \
  '{{ base_url }}/splash_pages/survey?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}' \
  -H 'Content-Type: multipart/form-data' \
  -F photo=@{{ photo_path }} \
  -F survey_type=multi_select \
  -F 'question=Bạn nghĩ gì về dịch vụ của chúng tôi' \
  -F auto_popup=https://www.facebook.com/nextifyvn/ \
  -F active=true \
  -F 'answer={
    "tag": {{ tag_id }},
    "value": "Nội dung câu trả lời"
}' \
  -F 'answer={
    "tag": {{ tag_id }},
    "value": "Nội dung câu trả lời"
}'

```

```
Form câu trả lời

{
    "tag": {{ id_tag }},
    "value": "Nội dung câu trả lời"
}
```

## Update trang chào khảo sát

<mark style="color:orange;">`PUT`</mark> `{{ base_url }}/splash_pages/survey`

Cho phép update trạng thái trạng chào khảo sát

#### Query Parameters

| Name       | Type   | Description                            |
| ---------- | ------ | -------------------------------------- |
| pos\_id    | string | i​d địa                                |
| splash\_id | string | id trang chào                          |
| status     | string | trạng thái kích hoạt (true hoặc false) |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |

{% tabs %}
{% tab title="200 Update thành công trang chào" %}

```javascript
{
    "status": 200,
    "message": "active splash page success!"
}
```

{% endtab %}

{% tab title="404 Trang chào không tồn tại" %}

```javascript
{
    "status": 404,
    "message": "splash_id does not exists!"
}
```

{% endtab %}
{% endtabs %}

```javascript
curl -X PUT \
  '{{ base_url }}/splash_pages/survey?pos_id={{ pos_id }}&splash_id={{ splash_id }}&status={{ status }}'
  -H 'Authorization: Bearer {{ access_token }}'
```

## Xóa trang chào

<mark style="color:red;">`DELETE`</mark> `{{ base_url }}/splash_pages/<type_page>`

Cho phép xóa trang chào

#### Query Parameters

| Name       | Type   | Description   |
| ---------- | ------ | ------------- |
| pos\_id    | string | id địa điểm   |
| splash\_id | string | id trang chào |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

```javascript
curl -X DELETE \
  '{{ base_url }}/splash_pages/{{ type_page }}?pos_id={{ pos_id }}&splash_id={{ splash_id }}'
  -H 'Authorization: Bearer {{ access_token }}'
```

| Loại trang chào             | type\_page |
| --------------------------- | ---------- |
| Trang chào theo khoảng ngày | promotion  |
| Trang chào theo giờ         | hour       |
| Trang chào khảo sát         | survey     |
| Trang chào sinh nhật        | birthday   |
| Trang chào theo lượt đến    | loyal      |
| Trang chào theo tag         | tag        |

## Lấy danh sách thứ tự ưu tiên trang chào

<mark style="color:blue;">`GET`</mark> `{{ base_url }}/splash_pages/priority`

Cho phép lấy danh sách thứ tự ưu tiên trang chào của một địa điểm

#### Query Parameters

| Name    | Type   | Description  |
| ------- | ------ | ------------ |
| pos\_id | string | i​d địa điểm |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |

{% tabs %}
{% tab title="200 Lấy thành công danh sách thứ tự trang chào" %}

```javascript
{
    "status": 200,
    "message": "Success!",
    "data": {
        "priority_splash_page": [
            thứ tự ưu tiên trang chào
        ],
        "priority_splash_page_status": [
            trang chào đã được kích hoạt và theo thứ tự ưu tiên
        ]
    }
}
```

{% endtab %}
{% endtabs %}

```javascript
curl -X GET \
  '{{ base_url }}/splash_pages/priority?pos_id={{ pos_id }}' \
  -H 'Authorization: Bearer {{ access_token }}'
```

## Thiết lập thứ tự ưu tiên trang chào

<mark style="color:green;">`POST`</mark> `{{ base_url }}/splash_pages/priority`

Cho phép thiết lập thứ tự ưu tiên trang chào

#### Query Parameters

| Name          | Type   | Description               |
| ------------- | ------ | ------------------------- |
| pos\_id       | string | id địa điểm               |
| splash\_pages | string | thứ tự ưu tiên trang chào |

#### Headers

| Name          | Type   | Description             |
| ------------- | ------ | ----------------------- |
| Authorization | string | Bearer \<access\_token> |

{% tabs %}
{% tab title="200 Thiết lập thành công" %}

```javascript
{
    "status": 200,
    "message": "Success!",
    "data": {
        "priority_splash_page": [
            thứ tự ưu tiên trang chào
        ]
    }
}
```

{% endtab %}
{% endtabs %}

```javascript
curl -X POST \
  '{{ base_url }}/splash_pages/priority?pos_id={{ pos_id }}&splash_pages=survey,birthday,weekday,hour,promotion,tag,loyal,plus_register,default' \
  -H 'Authorization: Bearer {{ access_token }}'
```
