Ba cách tích hợp

Có ba cách đưa một Showcase lên website. Ở cả ba, License key nằm trên một server và không bao giờ đến trình duyệt của khách. Khác nhau ở chỗ server đó là server nào và ai viết code cho nó.

Embed code, WordPress plugin and Shopify app. For each one, which server holds the License key and what you set up.

• Embed code

  Visitor's browser

  Your own serverA route you writeHolds the License key

  Comnoira API

  You set up

  1. Paste the SDK snippet on your page.
  2. Write one server route that calls Comnoira.
  3. Add your domain to the Showcase in the Dashboard.

• WordPress plugin

  Visitor's browser

  Your WordPress site/wp-json/comnoira/v1/sessionHolds the License key

  Comnoira API

  You set up

  1. Paste the License key in Comnoira, Connection.
  2. Register the Showcase ID and publicKey.
  3. Add the Comnoira Showcase block to a page.
  4. Add your domain to the Showcase in the Dashboard.

• Shopify app

  Visitor's browser

  The Comnoira app server/apps/comnoira/exchangeHolds the License key

  Comnoira API

  You set up

  1. Paste the License key on the Connection page.
  2. Pick or enter the Showcase.
  3. Add the Comnoira Showcase block in the theme editor.
  4. Add your store domains to the Showcase in the Dashboard.

In all three, the License key stays on a server and never reaches the browser.

Mã nhúng với server riêng

Bạn dán đoạn mã SDK vào trang và viết một route trên server của mình. Server của bạn giữ License key, chẳng hạn trong một biến môi trường. Route gọi Comnoira rồi trả mã trao đổi về trang.

Cách này hợp với site bạn tự xây. Bài Trao đổi session token trình bày request, phản hồi và các lỗi. Dashboard tạo sẵn đoạn mã và route server tương ứng bằng Node.js, Python, PHP hoặc Java.

Bạn cũng thêm domain website vào danh sách domain được phép của Showcase trong Dashboard.

Plugin WordPress

Plugin tên là Comnoira 3D Viewer. Plugin đóng vai server của bạn: lưu License key trên site WordPress của bạn ở dạng mã hoá và tự thực hiện các lời gọi tới Comnoira.

1. Cài và kích hoạt plugin.
2. Mở Comnoira, rồi Connection, và dán License key. Plugin lưu key mà không kiểm tra ngay. Lần Test Connection hoặc lần tải trang đầu tiên sẽ xác minh nó.
3. Mở Comnoira, rồi Showcases, và đăng ký một Showcase. Copy Showcase ID và publicKey từ Dashboard. Plugin gọi mục đầu là Embed ID. Plugin không có danh sách để chọn, nên bạn copy một lần cho mỗi Showcase. Bấm Test Connection để kiểm tra.
4. Sửa một trang, thêm block Comnoira Showcase và chọn Showcase đã đăng ký. Block có chiều rộng, chiều cao, tự xoay, và một ô tuỳ chọn nâng cao dạng JSON.
5. Thêm domain của site vào danh sách domain được phép của Showcase trong Dashboard.

Block chỉ ghi Showcase ID và publicKey vào trang, nên HTML của trang không chứa bí mật hay mã nào. Trình tải của plugin khởi động Viewer khi block cuộn vào màn hình. Nó gọi một route trên chính site WordPress của bạn, /wp-json/comnoira/v1/session. Route đó chỉ trả lời cho các Showcase đã đăng ký trong plugin, thêm License key của bạn và xin Comnoira mã trao đổi. Trình duyệt của khách sau đó hoàn tất bước đổi mã với Comnoira, như ở cách dùng mã nhúng.

Viewer theo ngôn ngữ mà theme đặt trong thuộc tính lang của trang, nên trang tiếng Việt có Viewer tiếng Việt.

Ứng dụng Shopify

Ứng dụng tên là Comnoira 3D Viewer. Server của ứng dụng giữ License key của bạn ở dạng mã hoá. Các trang của cửa hàng gọi ứng dụng qua một app proxy của Shopify tại /apps/comnoira/exchange.

1. Cài ứng dụng vào cửa hàng.
2. Mở trang Connection của ứng dụng và dán License key. Test connection cho biết Comnoira có chấp nhận key hay không.
3. Mở Showcases trong ứng dụng và thêm một Showcase. Ứng dụng liệt kê các Showcase của shop để bạn chọn. Nếu danh sách không tải được, bạn có thể tự nhập Showcase ID và publicKey.
4. Trong trình chỉnh theme, thêm block Comnoira Showcase vào một section và dán Showcase ID. Block còn có chiều rộng, chiều cao, tự xoay và ô tuỳ chọn nâng cao. Để mỗi sản phẩm hiện một Showcase khác nhau, nối ô Showcase ID với một metafield của sản phẩm bằng nút nguồn động.
5. Thêm các domain của cửa hàng vào danh sách domain được phép của Showcase trong Dashboard. Thiếu bước này Viewer sẽ trống.

Block chỉ đặt Showcase ID vào trang. Route của ứng dụng kiểm tra Showcase đã đăng ký cho cửa hàng của bạn, xin Comnoira mã trao đổi bằng License key, rồi trả mã kèm publicKey và địa chỉ của Comnoira. Route liệt kê từng trường một, nên License key không thể đi kèm.

Ai giữ License key

• Mã nhúng: server của chính bạn. Bạn viết route.
• WordPress: server WordPress của site bạn, bên trong plugin.
• Shopify: server của ứng dụng Comnoira.

Ở mỗi cách, danh sách domain được phép trong Dashboard quyết định website nào được hiển thị Showcase, và bước đổi mã ở trình duyệt áp dụng danh sách đó.