Khóa API

Khóa API cho phép trang web hoặc phần mềm của bạn làm việc với tài khoản Measure Map Online của bạn: hiển thị bản đồ của một dự án trên trang web, tạo dự án cho khách truy cập, hoặc đọc và thay đổi dự án qua REST API. Bạn tạo và quản lý khóa trên trang codeNhà phát triển.

Mở trang Nhà phát triển#

Trong menu bảng điều khiển, ở mục Nâng cao, nhấn codeNhà phát triển. Trang mở ra ở vpn_keyKhóa API, và các phần khác được liệt kê bên dưới trong menu (trên điện thoại, là các thẻ ở đầu trang):

• person_pin_circleLiên kết khách (Open Guest): liên kết không cần viết mã cho trang web của bạn. Xem Open Guest.
• terminalThử API, webhookWebhook và apiREST API: xem tài liệu tham khảo API.
• web_assetNhúng bản đồ (Enterprise): xem iFrame API.
• lock_open Dự án riêng tư (Enterprise): hiển thị dự án riêng tư của khách hàng trong bản đồ nhúng của bạn. Xem dự án riêng tư của khách hàng.

Huy hiệu ở đầu thẻ khóa cho biết khóa của bạn đang Hoạt động, Chưa kích hoạt (chưa có khóa), Đã tắt (quyền truy cập API bị tạm ngưng: không khóa nào dùng được và không thể tạo khóa mới cho đến khi bộ phận hỗ trợ gỡ bỏ) hay Đã hết hạn (gói đăng ký không còn hiệu lực).

Live và Sandbox#

Ở đầu thẻ khóa, chuyển qua lại giữa public Thực tế và science Sandbox. Mỗi môi trường có khóa riêng, và trang hiển thị khóa bạn chọn. Lựa chọn này cũng áp dụng trong terminalThử API, và được giữ nguyên khi bạn chuyển giữa các phần. web_assetNhúng bản đồ và person_pin_circleLiên kết khách luôn dùng khóa live của bạn, vì khách truy cập trang web của bạn chỉ mở được dự án live: mở một trong hai phần này sẽ đưa trang về Thực tế.

• Thực tế là tài khoản thật của bạn, và trang mở ở môi trường này. Hãy dùng khóa live trên trang web của bạn.
• Sandbox dùng để xây dựng và thử nghiệm một tích hợp. Dự án, thư mục và sản phẩm tạo bằng khóa sandbox được giữ tách biệt với dữ liệu thật của bạn: khóa live không thấy chúng, và khóa sandbox không thấy dữ liệu live của bạn. Các yêu cầu gửi bằng khóa sandbox không được tính vào số liệu sử dụng, và các dự án khách tạo bằng khóa này không bao giờ bị tính phí.

Tạo khóa sandbox mới không bao giờ ảnh hưởng đến khóa live của bạn, và ngược lại.

Chọn những gì khóa được phép làm#

Khi bạn tạo khóa, hộp thoại liệt kê từng khu vực của API trong Quyền truy cập của khóa mới. Hãy chọn khóa mới được với tới mức nào ở mỗi khu vực:

Hộp thoại chỉ hiển thị các khu vực có trong gói của bạn. Rê con trỏ lên một lựa chọn để xem chính xác nó cho phép gì. Khóa đầu tiên của bạn bắt đầu chỉ với Bản đồ nhúng, là tất cả những gì một bản đồ nhúng cần; khóa thay thế một khóa khác bắt đầu với quyền truy cập của khóa đó. Hãy chọn ít nhất một khu vực.

Những gì khóa được phép làm được cố định khi bạn tạo nó. Để cấp cho khóa nhiều hoặc ít quyền hơn, hãy tạo khóa mới.

Tạo khóa#

1. Chọn Thực tế hoặc Sandbox ở đầu thẻ khóa.
2. Nhấn addTạo khóa mới. Một hộp thoại mở ra, với public Thực tế hoặc science Sandbox bên cạnh tiêu đề.
3. Đặt quyền truy cập trong Quyền truy cập của khóa mới (xem ở trên).
4. Nếu muốn, nhập tên vào Tên cho khóa mới (tùy chọn) để phân biệt các khóa của bạn.
5. Nhấn addTạo.

Sau đó hộp thoại cho biết Khóa mới của bạn đã sẵn sàng. Bạn có thể sao chép lại từ trang này bất cứ lúc nào. Hộp thoại hiển thị khóa, được ẩn trừ những ký tự đầu và cuối, và những gì khóa Có thể làm. Nhấn visibility để hiện đầy đủ, hoặc content_copy để sao chép toàn bộ khóa, rồi nhấn Xong. Thẻ khóa hiển thị khóa theo cách tương tự trong Khóa API của bạn. Bạn nhận được email mỗi khi một khóa được tạo trên tài khoản của bạn.

Khóa tạo trước khi có cài đặt quyền truy cập#

Một khóa tạo trước khi khóa có cài đặt quyền truy cập có thể làm mọi thứ trừ làm việc với sản phẩm. Những khóa như vậy đang được ngừng sử dụng: thẻ khóa cho biết khi nào khóa của bạn ngừng hoạt động, và bạn cũng nhận được một thông báo. Hãy nhấn addTạo khóa mới, lúc này thẻ hiển thị là nút chính, và thay khóa cũ trên trang web hoặc máy chủ của bạn trước ngày đó. Hộp thoại bắt đầu chỉ với Bản đồ nhúng, nên hãy chọn thêm nếu máy chủ của bạn cần.

Thay thế khóa#

Nhấn lại addTạo khóa mới khi bạn đã có khóa, rồi tạo khóa mới trong hộp thoại. Hộp thoại cho biết điều gì xảy ra với khóa hiện tại: Một khóa mới sẽ được tạo và khóa hiện tại của bạn vẫn hoạt động trong 24 giờ, để bạn cập nhật các trang đang dùng nó. Bạn có thể thu hồi sớm hơn khi đã xong. Khóa tạo trước khi có cài đặt quyền truy cập vẫn hoạt động cho đến ngày bạn được thông báo.

Khóa cũ chuyển sang Các khóa trước, kèm thời gian còn lại, lần dùng gần nhất và những gì nó làm được. Vẫn được chấp nhận trong lúc bạn triển khai khóa mới. Hãy thu hồi một khóa ngay khi không còn gì dùng nó. Để dừng nó ngay lập tức, nhấn blockThu hồi và xác nhận; mọi trang web còn dùng khóa đó sẽ ngừng hoạt động ngay. Bạn nhận được email khi một khóa bị thu hồi.

Các hạn chế trang web của bạn được sao chép sang khóa mới. Bạn có thể tạo khóa mới khoảng một lần mỗi phút.

Giới hạn khóa cho các trang web của bạn#

Chỉ các trang web trong danh sách này mới có thể dùng khóa của bạn trong trình duyệt: bản đồ nhúng và yêu cầu từ trang trên bất kỳ trang web nào khác sẽ bị từ chối. Các lệnh gọi từ máy chủ không bị ảnh hưởng.

1. Trong Hạn chế trang web, nhập trang web của bạn vào Nhập trang web hoặc tên miền: một tên miền như example.com, một địa chỉ IP hoặc localhost. Bạn có thể dán địa chỉ đầy đủ: chỉ tên trang web được giữ lại, không kèm https://, đường dẫn hay cổng.
2. Nhấn addThêm.

Một tên miền cũng bao gồm các tên miền phụ của nó: example.com cho phép shop.example.com. Nhấn delete_outline để xóa một trang web và xác nhận; sau trang web cuối cùng, khóa hoạt động từ bất kỳ trang web nào. Bạn nhận được email mỗi khi một trang web bị xóa khỏi khóa.

Danh sách này áp dụng cho trình duyệt. Bản đồ nhúng chỉ mở trên một trang của trang web có trong danh sách; khi trình duyệt không cho biết trang đang ở đâu, bản đồ bị từ chối. Yêu cầu REST API gửi từ một trang web phải đến từ một trang web có trong danh sách. Yêu cầu từ chính máy chủ của bạn không nêu trang web nào và không bị kiểm tra. Bản thân Measure Map Online luôn được cho phép, nên các bản xem trước trên trang này vẫn hoạt động.

Xem khóa được sử dụng thế nào#

Mức sử dụng cộng gộp tất cả các khóa live của bạn, nên số liệu vẫn tiếp tục khi bạn thay khóa. Mục này hiển thị các yêu cầu trong 30 ngày qua, từ bản đồ nhúng lẫn REST API, với một cột cho mỗi ngày; tổng Từ trước đến nay; Truy cập lần cuối; thời điểm khóa hiện tại được tạo (Đã tạo khóa); và Miền hàng đầu: các trang web dùng khóa của bạn nhiều nhất. Một trang web bạn không nhận ra ở đó là lý do để hạn chế hoặc thay khóa.

Các yêu cầu sandbox không được tính, nên số liệu chỉ hiển thị ở Thực tế. Các yêu cầu do chính trang này gửi, trong terminalThử API và các bản xem trước, cũng không được tính.

Giữ khóa của bạn an toàn#

• Chỉ cấp cho mỗi khóa quyền truy cập nó cần. Khóa đặt trong trang web (ví dụ trong địa chỉ của bản nhúng) chỉ nên có Bản đồ nhúng.
• Khóa này có thể thay đổi dữ liệu của bạn. Hãy giữ nó trên máy chủ của bạn, không bao giờ đặt trong trang web hay ứng dụng.
• Hãy giới hạn khóa dùng trong trang web cho các trang web của chính bạn.
• Hãy để khóa ở trạng thái ẩn trên trang khi bạn chia sẻ màn hình; việc sao chép khóa không bao giờ cần hiện nó.
• Nếu khóa có thể đã bị lộ, hãy tạo khóa mới và thu hồi ngay khóa cũ trong Các khóa trước.
• Hãy xây dựng và thử nghiệm bằng khóa Sandbox, để các thử nghiệm không bao giờ lẫn vào dự án thật của bạn.