(spinner/how-to/spinner-api)=
# API Spinner

Để sử dụng API Spinner, người dùng làm theo các hướng dẫn dưới đây:

```{admonition} Pre-condition
* Access vào Workspace.
```

## Bước 1: Tạo Access Key cho Spinner.

Vào màn hình Container Spinner > API > Access Key ở menu bên trái để tạo Access key cho Spinner

Nhấn Create New Access Key để tạo mới 

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-1.png
:width: 80 %
:alt: Step
:align: center
```

Popup Create Access Key hiển thị, người dùng điền đầy đủ thông tin yêu cầu.

* Điền Access Key name

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-2.png
:width: 80 %
:alt: Step
:align: center
```

* Điền Description nếu có

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-3.png
:width: 80 %
:alt: Step
:align: center
```

* Chọn hoặc thêm Spinner và các quyền mong muốn

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-4.png
:width: 80 %
:alt: Step
:align: center
```

* Người dùng có thể set ngày hết hạn cho key

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-5.png
:width: 80 %
:alt: Step
:align: center
```

Sau đó nhấn Save And Download để lưu lại.

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-6.png
:width: 80 %
:alt: Step
:align: center
```

## Bước 2: Set API Spinner.

Vào màn hình Container Spinner > API > API ở menu bên trái.

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-7.png
:width: 80 %
:alt: Step
:align: center
```

1. Đọc thông tin Spinner: 

Người dùng nhấn vào Try it out để điền thông tin.

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-8.png
:width: 80 %
:alt: Step
:align: center
```

* Api-key: là chuỗi được encode dạng base64 từ chuỗi \<accessKey\>:\<secretKey\> với giá trị được cung cấp từ file access key đã tạo ở bước 1. 

VD: <span class="sd-text-danger">UWSKGHJRNYQVZFPC9C6OUW==</span>:<span class="sd-text-success">2D021057-7256-46DD-8D26-5B76370A5CD1</span>

Với: accessKey (chuỗi màu đỏ), secretKey (chuỗi màu xanh lá)

* spinnerUUID: lấy từ Spinner access key list.

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-9.png
:width: 80 %
:alt: Step
:align: center
```

* workspaceUUID: là UUID của workspace.

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-10.png
:width: 80 %
:alt: Step
:align: center
```

Sau khi điền thông tin, nhấn Execute.

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-11.png
:width: 80 %
:alt: Step
:align: center
```

2. Thay đổi thông tin Spinner: 

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-12.png
:width: 80 %
:alt: Step
:align: center
```

* Api-key: lấy từ chuỗi \<accessKey\>:\<secretKey\> được encode dạng base64.
* request: Nhập thông tin thay đổi cho spinner

3. Đọc thông tin container:

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-13.png
:width: 80 %
:alt: Step
:align: center
```

* Api-key: lấy từ chuỗi \<accessKey\>:\<secretKey\> được encode dạng base64.
* containerName: điền tên container, lấy từ list containers.
* spinnerUUID: UUID của spinner.
* workspaceUUID: UUID của workspace.

4. Đọc các giá trị của environment:

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-14.png
:width: 80 %
:alt: Step
:align: center
```

* Điền Api-key
* containerName: điền tên container, lấy từ list containers.
* environmentName: lên environment
* spinnerUUID: UUID của spinner.
* workspaceUUID: UUID của workspace.

5. Thay đổi image tag và biến môi trường:

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-15.png
:width: 80 %
:alt: Step
:align: center
```

* Điền Api-key
* Điền thông tin cần thay đổi.

6. Đọc thông tin các container thuộc spinner:

```{thumbnail} ../../../_static/img/spinner/how-to/spinner-api-16.png
:width: 80 %
:alt: Step
:align: center
```

* Điền Api-key
* spinnerUUID: UUID của spinner.
* workspaceUUID: UUID của workspace.

```{div} sd-fs-5 sd-text-primary
Result:
```

Sau khi chạy Execute, Responses trả về kết quả 200 là thành công.