# Xác thực quy trình

> operationId: `validateWorkflow`


## Yêu cầu

Endpoint này xác thực một quy trình. Với purpose=save, không được dùng environmentId/parameters. Với purpose=run, phải cung cấp cả hai. Với source.kind=inline, hãy gửi một TemplateWrite hoàn chỉnh, và kèm base khi bạn sửa đổi một mẫu hiện có. Với kind=template, hãy chỉ định đúng phiên bản đã lưu. Lỗi trong cấu trúc nội bộ của quy trình trả về 200+valid=false. Chỉ lỗi ở lớp vỏ (envelope) của yêu cầu mới trả về 400. Thao tác lưu và bắt đầu lượt chạy vẫn xác thực lại. Endpoint này không tạo ra validationToken nào có thể bỏ qua bước xác thực lại đó.

- **Điều kiện tiên quyết**: Bản đề xuất inline không cần được lưu trước. Việc đọc mẫu đã lưu, base hoặc các phụ thuộc cũng cần templates:read. Với purpose=run, còn cần thêm environments:read.
- **Xác thực truy cập**: Giống như ở các phần khác của Local API; xem [Xác thực](/vi/api-reference/getting-started/authentication). Tài nguyên thuộc phạm vi dữ liệu của tài khoản/nhóm hiện tại.
- **Tác dụng phụ**: Lệnh gọi này thực hiện xác thực chỉ đọc. Lệnh gọi không lưu mẫu, bí mật hay tệp. Lệnh gọi không mở trình duyệt hay cài đặt nhân trình duyệt.
- **Tín hiệu hoàn tất**: 200 chỉ có nghĩa là bước xác thực đã hoàn tất. Bạn phải kiểm tra data.valid, issues, truncated và runtimeChecks.
- **Thử lại**: Có thể thử lại các lệnh gọi chỉ đọc. Khi nhận 429 hoặc 503, hãy tạm dừng theo Retry-After.


### Endpoint

```http
POST /api/rpa/browser/v1/validations
```

Local API: `http://127.0.0.1:<port>/api/rpa/browser/v1/validations`. Dùng cổng được cấu hình trong ứng dụng.

### Header

| Tham số | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `Authorization` | string | Khi bật xác thực Local API | Xem [Xác thực](/vi/api-reference/getting-started/authentication). |


Kiểu nội dung: `Content-Type: application/json` (bắt buộc).

### Tham số đường dẫn

Không có.

### Tham số truy vấn

Không có.

### Phần thân yêu cầu

**Tùy chọn 1**

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `purpose` | `"save"` | Có | Với save, chỉ kiểm tra các điều kiện để lưu. Với run, còn kiểm tra thêm tham số, môi trường và giới hạn của lượt chạy. |
| `source` | [ValidationSource](/vi/browser-rpa/api/data-types#validationsource) | Có | Chọn một mẫu đề xuất hoặc một mẫu đã lưu. Dùng đúng một tùy chọn. |


**Tùy chọn 2**

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `purpose` | `"run"` | Có | Với save, chỉ kiểm tra các điều kiện để lưu. Với run, còn kiểm tra thêm tham số, môi trường và giới hạn của lượt chạy. |
| `source` | [ValidationSource](/vi/browser-rpa/api/data-types#validationsource) | Có | Chọn một mẫu đề xuất hoặc một mẫu đã lưu. Dùng đúng một tùy chọn. |
| `environmentId` | string | Có | ID của một môi trường thực tế. Lấy ID từ truy vấn môi trường. Độ dài tối thiểu 1; độ dài tối đa 128. |
| `parameters` | [ParameterValues](/vi/browser-rpa/api/data-types#parametervalues) | Có | Ánh xạ từ tên tham số sang {kind:json,value:JSON} (văn bản thuần cho tham số riêng tư, đường dẫn cục bộ tuyệt đối cho tham số tệp; xem ParameterValues). Dùng {} khi không có tham số. |


Mô hình đầy đủ: [ValidationRequest](/vi/browser-rpa/api/data-types#validationrequest).

Về hai cấu trúc loại trừ lẫn nhau của source, xem [ValidationSource](/vi/browser-rpa/api/data-types#validationsource). Với purpose=run, endpoint chỉ thực hiện kiểm tra trước và không chạy quy trình.

### Ví dụ yêu cầu

Đây là ví dụ minh họa trong tài liệu; ví dụ này chưa được gửi tới một ứng dụng đang chạy thực tế. Đặt `RPA_BASE_URL` theo mô tả trong [Quy ước API](/vi/browser-rpa/api/common). Các biến tài nguyên, bản sửa đổi danh mục và ETag lấy từ phản hồi thực tế.

Lưu toàn bộ JSON dưới đây thành `validate-workflow.request.json`. Thay mọi giá trị có định danh chứa `example` bằng giá trị từ phản hồi thực tế. ID nút trong ví dụ tạo mẫu là ID cục bộ trong phạm vi quy trình và có thể giữ nguyên.

```json
{
  "purpose": "save",
  "source": {
    "kind": "inline",
    "template": {
      "title": "Read the page URL",
      "description": "Visit the given page and return its URL",
      "workflow": {
        "editorVersion": 2,
        "editorParametersVersion": 1,
        "variables": {
          "type": "object",
          "properties": {
            "targetUrl": {
              "type": "string",
              "description": "HTTP(S) URL to visit"
            }
          },
          "required": [
            "targetUrl"
          ]
        },
        "nodes": [
          {
            "id": "start",
            "type": "start"
          },
          {
            "id": "visit",
            "type": "browser_gotoUrl",
            "data": {
              "browserAction": "gotoUrl",
              "browserUi": {
                "inputs": {
                  "url": "${targetUrl}",
                  "postWaitMs": 500
                }
              }
            }
          },
          {
            "id": "url_result",
            "type": "browser_getUrl",
            "data": {
              "browserAction": "getUrl",
              "browserUi": {
                "inputs": {
                  "type": "href"
                }
              }
            }
          },
          {
            "id": "end",
            "type": "end",
            "data": {
              "inputsValues": {
                "status": {
                  "type": "constant",
                  "content": "success"
                },
                "message": {
                  "type": "ref",
                  "content": [
                    "url_result",
                    "data",
                    "value"
                  ]
                }
              }
            }
          }
        ]
      },
      "dependencies": []
    }
  }
}
```

```bash
curl -i -X POST "${RPA_BASE_URL}/validations" \
  -H 'Content-Type: application/json' \
  --data-binary @validate-workflow.request.json
```

## Phản hồi

### 200

200 chỉ có nghĩa là bước xác thực đã hoàn tất. Bạn phải kiểm tra data.valid, issues, truncated và runtimeChecks.

Phần thân: `application/json`. Trường `data` ở cấp cao nhất dùng mô hình bên dưới. Về `meta`, xem [Metadata](/vi/browser-rpa/api/data-types#metadata).

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `valid` | boolean | Có | Là true khi không có lỗi tĩnh. Không có nghĩa là lượt chạy thực tế sẽ thành công. |
| `issues` | array<[Issue](/vi/browser-rpa/api/data-types#issue)> | Có | Danh sách các vấn đề có cấu trúc. Là [] khi không có vấn đề nào. |
| `truncated` | boolean | Có | Là true khi đã chạm giới hạn số vấn đề. Hãy xác thực lại sau khi sửa các vấn đề. |
| `runtimeChecks` | array<object> | Có | Các mục vẫn cần xác nhận khi chạy. Mảng rỗng không chứng minh rằng trang web thật dùng được, và cũng không giải thích vì sao không có mục nào. |
| `effectiveInputs` | object | Có | Bản tóm tắt chẩn đoán tùy chọn, có khóa là nodeId. defaultsApplied chỉ chứa các giá trị mặc định an toàn được bổ sung trong lần xác thực này, còn unresolvedFields liệt kê các trường đầu vào chưa được phân giải. Các mục có thể bị bỏ qua, hoặc có thể trả về {}, nên việc thiếu một mục không cho biết quá trình chuẩn hóa có diễn ra hay không. |
| `workflowHash` | string | Có | Định danh nội dung dùng cho chẩn đoán. Không đảm bảo giữ ổn định giữa nguồn inline/đã lưu, giữa các danh mục hoặc giữa các bước chuẩn hóa, và không chứng minh rằng quy trình đã được lưu. Xem các quy tắc bổ sung trong common.md. |
| `catalogRevision` | string | Có | Bản sửa đổi nội dung của các hợp đồng nút. Định dạng: sha256: theo sau là 64 chữ số thập lục phân. |
| `dependencyRevisions` | array<[DependencyPin](/vi/browser-rpa/api/data-types#dependencypin)> | Có | Các bản sửa đổi phụ thuộc chính xác được dùng để cố định hoặc xác thực. |


**Các trường của `runtimeChecks[]`**

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `runtimeChecks[].nodeId` | string | Có | ID nút ổn định trong mẫu. Độ dài tối thiểu 1; độ dài tối đa 128. |
| `runtimeChecks[].field` | string | Có | Trường đầu vào của nút hoặc trường quy tắc tương ứng. |
| `runtimeChecks[].code` | string | Có | Giá trị chung hiện tại là RPA_RUNTIME_CHECK_REQUIRED. Một mã chưa biết được bổ sung trong tương lai vẫn có nghĩa là đang chờ xác nhận khi chạy. Xem common.md. |
| `runtimeChecks[].reason` | string | Có | Lý do không khả dụng, lý do cách ly hoặc lý do cần kiểm tra khi chạy. |


### Ví dụ phản hồi

Mọi ID, dấu thời gian, giá trị băm và kết quả lượt chạy đều là dữ liệu ví dụ. Các giá trị này không cho thấy ví dụ đã được thực thi.

```json
{
  "data": {
    "valid": true,
    "issues": [],
    "truncated": false,
    "runtimeChecks": [
      {
        "nodeId": "visit",
        "field": "url",
        "code": "RPA_RUNTIME_CHECK_REQUIRED",
        "reason": "Save validation does not visit the target website. Actual connectivity must be confirmed at run time"
      }
    ],
    "effectiveInputs": {},
    "workflowHash": "sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
    "catalogRevision": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "dependencyRevisions": []
  },
  "meta": {
    "requestId": "7d498f20-7bab-4e59-9b05-88daf51230e9",
    "catalogRevision": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}
```

### Phản hồi lỗi

| HTTP | error.code | Cách xử lý |
|  --- | --- | --- |
| 409 | RPA_TEMPLATE_VERSION_CONFLICT | version trong source.kind=template hoặc base.version trong source.kind=inline đã cũ. Cả hai trường hợp đều trả về lỗi này kèm VersionConflictDetails. Hãy GET lại phiên bản mới nhất, hợp nhất, rồi xác thực lại. Lệnh gọi chỉ để xác thực không có biên nhận. |
| 409 | RPA_DEPENDENCY_VERSION_UNAVAILABLE | Thông tin ghim của một phụ thuộc không phải là bản sửa đổi hiện đang khả dụng. |
| 503 | RPA_VALIDATION_TIMEOUT | Bước xác thực chỉ đọc đã hết thời gian chờ. Hãy thử lại theo Retry-After. |


Về các lỗi 400/401/403/404/429/5xx thường gặp và các trường mô tả thất bại, xem [Lỗi và khôi phục](/vi/browser-rpa/api/common#l%E1%BB%97i-v%C3%A0-kh%C3%B4i-ph%E1%BB%A5c). Ví dụ phản hồi lỗi (403):

```json
{
  "error": {
    "code": "RPA_PERMISSION_DENIED",
    "message": "The request Host or Origin is not allowed, or the current identity can't access the target environment",
    "retryable": false,
    "issues": [],
    "details": null
  },
  "meta": {
    "requestId": "7d498f20-7bab-4e59-9b05-88daf51230e9",
    "catalogRevision": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}
```

## Liên quan

[Tham chiếu Local API](/vi/browser-rpa/local-api) · [Quy ước API](/vi/browser-rpa/api/common) · [Mô hình dữ liệu](/vi/browser-rpa/api/data-types) · [Cấu trúc quy trình](/vi/browser-rpa/api/workflow) · [Bắt đầu nhanh](/vi/browser-rpa/quickstart)

### Vị trí lỗi trong bước kiểm tra trước khi chạy

Các URL HTTP(S) có thể xác định từ tham số thực tế sẽ được xác thực trong bước kiểm tra trước, và vấn đề sẽ trỏ đến `/parameters/<name>/value`. Các URL phụ thuộc vào kết quả của các nút trước đó vẫn được liệt kê trong runtimeChecks và được kiểm tra khi thực thi. Tham số bắt buộc bị thiếu sẽ trỏ đến `/parameters/<name>`. Khi môi trường không tồn tại hoặc ứng dụng không thể phân giải môi trường, phản hồi là 200 kèm valid=false và RPA_ENVIRONMENT_UNAVAILABLE, tại vị trí `/environmentId`. Khi môi trường đang bận, phản hồi có cùng cấu trúc với code=RPA_ENVIRONMENT_BUSY. Khi môi trường nằm ngoài phạm vi được cấp quyền, phản hồi là HTTP 404, và phản hồi này không tiết lộ môi trường có tồn tại hay không.