POST/v1/access-requests/{request_id}/grant

Cấp quyền truy cập theo yêu cầu

grant_access_request

Dùng các cơ chế truy cập hiện có: collection_ids gán vai trò người xem cho người dùng trên các bộ sưu tập của nguồn (cần COLLECTION_MANAGE_PERMISSIONS trên từng bộ sưu tập); data_profile gán một hồ sơ dữ liệu cho người dùng (ORG_MANAGE_USERS); add_category thêm các danh mục của nguồn vào hồ sơ dữ liệu hiện tại của người dùng (chỉ quản trị viên; ảnh hưởng tới mọi người dùng của hồ sơ, số người này nằm trong profile_users). Các nguồn mà người dùng truy cập được sau khi cấp quyền được đánh dấu là đã cấp; khi tất cả đã được cấp, yêu cầu chuyển thành granted, và người dùng nhận thông báo. Được thêm trong 1.50.0.

Xác thực

Gửi khóa API trong header Authorization: Authorization: Bearer <khóa>.

Tham số đường dẫn

request_idintegerbắt buộc

Tham số header

X-View-Asstring
Chỉ dành cho khóa API có vai trò admin. Thực hiện yêu cầu với tư cách hồ sơ dữ liệu <profile>[:viewer|verifier|editor], ví dụ employee:viewer. Khóa cài đặt không thể dùng header này (403).
Idempotency-Keystring
Khóa để thử lại an toàn một thao tác ghi: 1 đến 255 ký tự ASCII in được; nên dùng một UUID v4 cho mỗi thao tác logic. Lần thử lại với cùng khóa trong vòng 24 giờ không chạy lại thao tác: dịch vụ trả về phản hồi đã lưu (trạng thái, header và phần thân) kèm header Idempotency-Replayed: true. Cùng khóa nhưng khác phương thức, đường dẫn, Content-Type hoặc phần thân trả về 409 api.idempotency_mismatch; khi yêu cầu đầu tiên vẫn đang chạy, trả về 409 api.idempotency_in_progress kèm Retry-After: 1. Sau phản hồi 5xx hoặc 429, khóa được giải phóng và lần thử lại sẽ chạy lại thao tác. Khóa có phạm vi theo tổ chức và bên gọi (khóa API, người dùng hoặc khóa nguồn tùy chỉnh).
length ≥ 1, length ≤ 255

Tham số cookie

kb_view_asstring
Cookie của chế độ “View as” cho một phiên. POST /auth/view-as đặt cookie này, còn DELETE /auth/view-as xóa nó.

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

application/json

Đối tượng: AccessRequestGrant

collection_idsarray of integer
data_profilestring
Khóa của hồ sơ dữ liệu sẽ gán cho người dùng.
add_categoryboolean

Phản hồi

200Yêu cầu sau khi cấp quyền

Header phản hồi

RateLimit-Policy
Các giới hạn đang áp dụng, theo định dạng của bản dự thảo IETF draft-ietf-httpapi-ratelimit-headers: các mục phân tách bằng dấu phẩy "<name>";q=<quota>;w=<window in seconds>. key là tốc độ yêu cầu của khóa API (hạn mức là đợt tăng đột biến, khung thời gian là thời gian để hạn mức hồi lại hoàn toàn; với phiên là user, khi không có thông tin xác thực là ip); minute, day và month là hạn mức của tổ chức cho phút, ngày và tháng theo lịch, tính theo UTC.
RateLimit
Phần còn lại của mỗi giới hạn trong RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Giới hạn của mục chặt nhất trong RateLimit-Policy (mục còn ít yêu cầu nhất).
X-RateLimit-Remaining
Số yêu cầu còn lại theo giới hạn chặt nhất.
X-RateLimit-Reset
Số giây cho đến khi giới hạn chặt nhất được đặt lại.
Idempotency-Replayed
true nghĩa là phản hồi được phát lại từ phản hồi đã lưu cho Idempotency-Key này: thao tác không chạy lại.

application/json

Đối tượng: AccessRequest

idintegerbắt buộc
statusstringbắt buộc
Giá trị cho phép: opengranteddenied
answer_idstring
Câu trả lời đã dẫn tới yêu cầu truy cập (trống khi câu trả lời đã bị xóa theo chính sách lưu giữ).
questionstringbắt buộc
messagestringbắt buộc
commentstring
Bình luận khi từ chối.
totalintegerbắt buộc
Số nguồn trong yêu cầu (với người quyết định, là các nguồn mà họ nhìn thấy).
pendingintegerbắt buộc
Chưa được cấp.
mergedboolean
Trong phản hồi của yêu cầu tạo, cho biết yêu cầu đã được gộp vào một yêu cầu đang mở.
decided_atstring (date-time)
created_atstring (date-time)bắt buộc
updated_atstring (date-time)bắt buộc
userAccessRequestUser
sourcesarray of AccessRequestSource
Chỉ dành cho người quyết định.
can_add_categoryboolean
profile_usersinteger
Người dùng đang hoạt động thuộc hồ sơ dữ liệu của người yêu cầu (thay đổi hồ sơ sẽ ảnh hưởng đến tất cả họ).

400Yêu cầu không hợp lệ: giá trị tham số hoặc trạng thái của đối tượng không cho phép thực hiện hành động (`detail` là thông báo).

Header phản hồi

RateLimit-Policy
Các giới hạn đang áp dụng, theo định dạng của bản dự thảo IETF draft-ietf-httpapi-ratelimit-headers: các mục phân tách bằng dấu phẩy "<name>";q=<quota>;w=<window in seconds>. key là tốc độ yêu cầu của khóa API (hạn mức là đợt tăng đột biến, khung thời gian là thời gian để hạn mức hồi lại hoàn toàn; với phiên là user, khi không có thông tin xác thực là ip); minute, day và month là hạn mức của tổ chức cho phút, ngày và tháng theo lịch, tính theo UTC.
RateLimit
Phần còn lại của mỗi giới hạn trong RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Giới hạn của mục chặt nhất trong RateLimit-Policy (mục còn ít yêu cầu nhất).
X-RateLimit-Remaining
Số yêu cầu còn lại theo giới hạn chặt nhất.
X-RateLimit-Reset
Số giây cho đến khi giới hạn chặt nhất được đặt lại.

application/json

Đối tượng: Error

401Không có thông tin xác thực nào được gửi (không có cookie phiên lẫn khóa API), hoặc không tìm thấy khóa.

Header phản hồi

RateLimit-Policy
Các giới hạn đang áp dụng, theo định dạng của bản dự thảo IETF draft-ietf-httpapi-ratelimit-headers: các mục phân tách bằng dấu phẩy "<name>";q=<quota>;w=<window in seconds>. key là tốc độ yêu cầu của khóa API (hạn mức là đợt tăng đột biến, khung thời gian là thời gian để hạn mức hồi lại hoàn toàn; với phiên là user, khi không có thông tin xác thực là ip); minute, day và month là hạn mức của tổ chức cho phút, ngày và tháng theo lịch, tính theo UTC.
RateLimit
Phần còn lại của mỗi giới hạn trong RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Giới hạn của mục chặt nhất trong RateLimit-Policy (mục còn ít yêu cầu nhất).
X-RateLimit-Remaining
Số yêu cầu còn lại theo giới hạn chặt nhất.
X-RateLimit-Reset
Số giây cho đến khi giới hạn chặt nhất được đặt lại.

application/json

Đối tượng: Error

403Hành động không được phép: vai trò không đủ quyền, không có quyền truy cập vào bộ sưu tập hoặc thẻ, yêu cầu chạy ở chế độ “View as”, hoặc tổ chức bị tạm ngưng hay đã bị xóa (`detail` là đối tượng có `code: org_suspended | org_deleted`).

Header phản hồi

RateLimit-Policy
Các giới hạn đang áp dụng, theo định dạng của bản dự thảo IETF draft-ietf-httpapi-ratelimit-headers: các mục phân tách bằng dấu phẩy "<name>";q=<quota>;w=<window in seconds>. key là tốc độ yêu cầu của khóa API (hạn mức là đợt tăng đột biến, khung thời gian là thời gian để hạn mức hồi lại hoàn toàn; với phiên là user, khi không có thông tin xác thực là ip); minute, day và month là hạn mức của tổ chức cho phút, ngày và tháng theo lịch, tính theo UTC.
RateLimit
Phần còn lại của mỗi giới hạn trong RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Giới hạn của mục chặt nhất trong RateLimit-Policy (mục còn ít yêu cầu nhất).
X-RateLimit-Remaining
Số yêu cầu còn lại theo giới hạn chặt nhất.
X-RateLimit-Reset
Số giây cho đến khi giới hạn chặt nhất được đặt lại.

application/json

Đối tượng: Error

404Đối tượng không tồn tại hoặc bạn không có quyền truy cập. API không xác nhận sự tồn tại của đối tượng bị hạn chế quyền truy cập.

Header phản hồi

RateLimit-Policy
Các giới hạn đang áp dụng, theo định dạng của bản dự thảo IETF draft-ietf-httpapi-ratelimit-headers: các mục phân tách bằng dấu phẩy "<name>";q=<quota>;w=<window in seconds>. key là tốc độ yêu cầu của khóa API (hạn mức là đợt tăng đột biến, khung thời gian là thời gian để hạn mức hồi lại hoàn toàn; với phiên là user, khi không có thông tin xác thực là ip); minute, day và month là hạn mức của tổ chức cho phút, ngày và tháng theo lịch, tính theo UTC.
RateLimit
Phần còn lại của mỗi giới hạn trong RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Giới hạn của mục chặt nhất trong RateLimit-Policy (mục còn ít yêu cầu nhất).
X-RateLimit-Remaining
Số yêu cầu còn lại theo giới hạn chặt nhất.
X-RateLimit-Reset
Số giây cho đến khi giới hạn chặt nhất được đặt lại.

application/json

Đối tượng: Error

409Trạng thái của đối tượng không cho phép thực hiện hành động, ví dụ bản trùng lặp, đang lập chỉ mục, hoặc tác vụ đã được xử lý.

Header phản hồi

RateLimit-Policy
Các giới hạn đang áp dụng, theo định dạng của bản dự thảo IETF draft-ietf-httpapi-ratelimit-headers: các mục phân tách bằng dấu phẩy "<name>";q=<quota>;w=<window in seconds>. key là tốc độ yêu cầu của khóa API (hạn mức là đợt tăng đột biến, khung thời gian là thời gian để hạn mức hồi lại hoàn toàn; với phiên là user, khi không có thông tin xác thực là ip); minute, day và month là hạn mức của tổ chức cho phút, ngày và tháng theo lịch, tính theo UTC.
RateLimit
Phần còn lại của mỗi giới hạn trong RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Giới hạn của mục chặt nhất trong RateLimit-Policy (mục còn ít yêu cầu nhất).
X-RateLimit-Remaining
Số yêu cầu còn lại theo giới hạn chặt nhất.
X-RateLimit-Reset
Số giây cho đến khi giới hạn chặt nhất được đặt lại.

application/json

Đối tượng: Error

429Quá nhiều yêu cầu (`api.rate_limited`), hạn mức của tổ chức theo phút, ngày hoặc tháng đã dùng hết (`api.quota_exceeded`; `error.details` chứa `quota`, `limit` và `reset_at`), tổ chức đã đạt giới hạn, hoặc dịch vụ trả lời đang bận (`answers.engine_busy`). Hãy chờ khoảng thời gian ghi trong header `Retry-After`.

Header phản hồi

Retry-After
Số giây cần chờ trước khi thử lại yêu cầu.
RateLimit-Policy
Các giới hạn đang áp dụng, theo định dạng của bản dự thảo IETF draft-ietf-httpapi-ratelimit-headers: các mục phân tách bằng dấu phẩy "<name>";q=<quota>;w=<window in seconds>. key là tốc độ yêu cầu của khóa API (hạn mức là đợt tăng đột biến, khung thời gian là thời gian để hạn mức hồi lại hoàn toàn; với phiên là user, khi không có thông tin xác thực là ip); minute, day và month là hạn mức của tổ chức cho phút, ngày và tháng theo lịch, tính theo UTC.
RateLimit
Phần còn lại của mỗi giới hạn trong RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Giới hạn của mục chặt nhất trong RateLimit-Policy (mục còn ít yêu cầu nhất).
X-RateLimit-Remaining
Số yêu cầu còn lại theo giới hạn chặt nhất.
X-RateLimit-Reset
Số giây cho đến khi giới hạn chặt nhất được đặt lại.

application/json

Đối tượng: Error

Mã lỗi

Các mã endpoint này có thể trả về trong error.code, ngoài các mã chung của mọi yêu cầu.

Thử lại an toàn

Gửi header Idempotency-Key (ví dụ một UUID) với mỗi yêu cầu POST và PATCH. Một lần thử lại với cùng khóa trong vòng 24 giờ trả về phản hồi đã lưu thay vì thực hiện lại yêu cầu.

Giới hạn tốc độ

Phản hồi có các header RateLimit và RateLimit-Policy cùng các header cũ hơn X-RateLimit-Limit, X-RateLimit-Remaining và X-RateLimit-Reset. Phản hồi 429 có Retry-After tính bằng giây: hãy chờ rồi thử lại.

← access-requests · Tài liệu tham chiếu API

curl -X POST 'https://api.sursa.com/v1/access-requests/1/grant' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"collection_ids":[1],"data_profile":"string","add_category":false}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Dùng thử

Khóa API

Khóa chỉ được giữ trong bộ nhớ của tab này và chỉ được gửi tới https://api.sursa.com.

Yêu cầu tác động lên dữ liệu thật của tổ chức bạn.

X-View-As header

request_id path *

Idempotency-Key header

Idempotency-Key

Khi để trống, mỗi yêu cầu sẽ được tạo một khóa mới.

Phần thân yêu cầu (JSON)