Chuyển đến nội dung

API công khai

Tạo khóa API và chọn phạm vi quyền cho nó

Tạo khóa trong đúng không gian làm việc mà nó sẽ hoạt động, chỉ cấp những phạm vi quyền mà phần tích hợp cần, và cất nó như một bí mật. Khóa chỉ hiện một lần — nếu mất, hãy thu hồi và cấp cái mới.

Các bước

  1. Tạo khóa bên trong không gian làm việc mà nó sẽ chạm tới mã. Khóa không đi xuyên giữa các không gian.
  2. Cấp phạm vi quyền hẹp nhất mà phần tích hợp vẫn chạy được — chỉ đọc nếu nó chỉ đọc.
  3. Chép khóa vào kho bí mật của bạn ngay lập tức.
  4. Xác thực bằng mã Bearer hoặc header X-Mosaqo-API-Key, tùy ứng dụng khách của bạn.
  5. Giới hạn theo địa chỉ ở nơi làm được, và xoay khóa theo lịch.

Cách kiểm chứng kết quả

Gọi một điểm cuối định danh như /me. Nó phải trả về đúng không gian làm việc bạn chờ đợi, và điều đó cũng xác nhận khóa có hiệu lực ở đâu.

Chỗ thường sai

  • Một khóa lỡ commit vào kho mã hoặc dán vào nhóm chat.
  • Một khóa toàn năng duy nhất dùng chung cho mọi phần tích hợp.
  • Một khóa tạo nhầm không gian làm việc, rồi trả 403 cho mọi thứ.
Bài này có giải quyết được việc của bạn không?

Cách này không giúp được

Hãy viết cho chúng tôi kèm nền tảng và phiên bản, các bước bạn đã làm, kết quả mong đợi, cùng không gian làm việc hay mã QR liên quan. Che mọi thông tin bí mật trước khi đính kèm bất cứ thứ gì.

Viết cho bộ phận hỗ trợ