Xác thực

Việc sử dụng Meshy API yêu cầu xác thực. Hướng dẫn này sẽ chỉ cho bạn cách tạo tài khoản và khóa API.

API Keys

Tạo tài khoản Meshy

Meshy API yêu cầu bạn phải có tài khoản Meshy để tạo và quản lý khóa API. Nếu một yêu cầu được gửi đến API mà không có khóa API, API sẽ phản hồi với lỗi thông tin xác thực không hợp lệ.

Bạn có thể tạo tài khoản Meshy bằng cách truy cập trang web chính thức của Meshy và đăng ký.

Tạo khóa API

Sau khi đã tạo tài khoản Meshy, bạn có thể tạo khóa API tại trang API Keys trong Developer Platform.

Bạn có thể tạo nhiều khóa API cho các mục đích khác nhau. Ví dụ, bạn có thể tạo một khóa API cho ứng dụng iOS và một khóa khác cho ứng dụng web của mình. Mức sử dụng của mỗi khóa API được theo dõi riêng biệt, và bạn có thể thu hồi chúng bất cứ lúc nào.

Bạn cũng có thể đặt giới hạn credit hàng tháng cho bất kỳ khóa nào, giới hạn số lượng khóa đó có thể sử dụng bất kể mức sử dụng tổng thể của tài khoản bạn — hữu ích để giới hạn một khóa mà bạn giao cho một nhà thầu hoặc một môi trường cụ thể.

Để tạo một khóa API, hãy nhấp vào nút Create API Key trên trang API, sau đó nhập tên cho khóa API của bạn.

Sau khi đã tạo một khóa API, bạn sẽ được hiển thị giá trị khóa API. Bạn có thể sao chép giá trị khóa API và lưu trữ nó ở một nơi an toàn.

Bạn sẽ không thể xem lại giá trị khóa API này một lần nữa.

Sử dụng khóa API

Sau khi đã tạo một khóa API, bạn có thể sử dụng nó để xác thực các yêu cầu của mình tới Meshy API. Bạn có thể truyền khóa API của mình vào API thông qua header Authorization, một ví dụ về header được hiển thị bên dưới.

{
  "Authorization": "Bearer msy_sOmEbOgUsApIkEyFoReXaMpLe1234567890"
}

Security

Chúng tôi coi trọng vấn đề bảo mật tại Meshy, và chúng tôi nỗ lực hết sức để đảm bảo Meshy API luôn an toàn. Chúng tôi hy vọng dữ liệu của bạn và dữ liệu của người dùng của bạn luôn được an toàn khi sử dụng dịch vụ của chúng tôi. Dưới đây là một số hướng dẫn tổng quát để giúp bạn giữ an toàn cho dữ liệu và các yêu cầu của mình khi sử dụng Meshy API, nhưng cũng hãy đảm bảo tuân theo các hướng dẫn được áp dụng tại nhóm hoặc nơi làm việc của bạn.

Transport Layer Security

Mặc dù dữ liệu của bạn được mã hóa khi lưu trữ (at rest) một khi đã được lưu tại Meshy, Meshy API sử dụng và bắt buộc áp dụng TLS, để mã hóa dữ liệu trong quá trình truyền tải. Điều này có nghĩa là tất cả các yêu cầu đến và đi từ Meshy API đều được gửi qua HTTPS, và bất kỳ yêu cầu nào được gửi qua HTTP sẽ nhận được mã trạng thái 301 Moved Permanently. Mặc dù không được khuyến khích, trong một số trường hợp, nếu bạn phải giao tiếp qua HTTP, bạn cần phải khai báo rõ ràng cho HTTP client của mình để thực hiện theo các chuyển hướng từ HTTP sang HTTPS. Dưới đây là một số ví dụ:

# use `-L` to follow HTTP to HTTPS redirections
curl -L https://api.meshy.ai/openapi/v1/balance \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Các chuyển hướng chỉ hoạt động với các yêu cầu GET: HTTP client sẽ gửi lại một yêu cầu POST bị chuyển hướng dưới dạng GET mà không có nội dung (body) của nó, vì vậy hãy luôn gọi trực tiếp https:// khi tạo tác vụ.

Bảo mật khóa API

Một khi đã được tạo ra, khóa API sẽ không còn hiển thị trong bảng điều khiển nữa, vì vậy hãy tải xuống và giữ nó an toàn và bảo mật, vì bất kỳ ai có được nó đều có thể sử dụng nó để giao tiếp với Meshy API thay mặt bạn. Nếu bạn tin rằng khóa API của mình đã bị xâm phạm, bạn có thể thu hồi nó bất cứ lúc nào từ bảng điều khiển, một khi đã bị thu hồi, nó sẽ không còn hợp lệ nữa.

Công bố vấn đề bảo mật

Nếu bạn tin rằng mình đã phát hiện ra một vấn đề bảo mật trong Meshy API, vui lòng liên hệ với chúng tôi. Chúng tôi đánh giá cao việc công bố có trách nhiệm của bạn và sẽ nỗ lực hết sức để ghi nhận đóng góp của bạn.