Bỏ qua đến nội dung chính
Tất cả bộ sưu tậpTích hợp & Quan hệ đối tác
Bắt đầu với API Webex Events
Bắt đầu với API Webex Events

API làm gì và bắt đầu như thế nào

Daniel Murphey avatar
Được viết bởi Daniel Murphey
Đã cập nhật cách đây hơn 1 tuần

Bài báo này được dịch từ tiếng Anh bằng cách sử dụng dịch máy.

Nếu trong nhóm của bạn có một nhà phát triển biết cách sử dụng API GraphQL thì API Webex Events có thể là cánh cổng giúp bạn tiếp cận các tính năng tự động hóa quản lý và thiết lập sản phẩm và sự kiện mạnh mẽ, tích hợp nền tảng của bên thứ ba, bảng thông tin dữ liệu đa sự kiện mạnh mẽ, v.v. .

API Webex Events có thể làm gì

Nói một cách đơn giản, API là giao diện lập trình mà nhà phát triển có thể sử dụng để lấy dữ liệu từ đó hoặc đưa dữ liệu vào nền tảng trực tuyến - trong trường hợp này là Webex Events.

Các khả năng của API có thể được đơn giản hóa thành bốn khái niệm cơ bản:

  • Tạo nội dung nào đó chưa tồn tại trước đây, chẳng hạn như người tham dự, Phiên hoặc toàn bộ Sự kiện.

  • Cập nhật mọi thứ mà API có thể sử dụng để tạo, cùng với một số thứ khác. Ví dụ: API có thể được sử dụng để tạo người tham dự mới, sau đó chỉnh sửa tên, email, trạng thái, nhóm, số điện thoại và tài khoản mạng xã hội của người tham dự đó.

  • Đọc thông tin về mọi thứ mà API có thể dùng để tạo hoặc chỉnh sửa, cùng với một số thứ không thể.

  • Xóa mọi thứ mà API có thể được sử dụng để tạo, ngoại trừ một số trường hợp ngoại lệ.

Hãy ghi nhớ những khái niệm này khi đọc phần 'Làm việc với nhà phát triển' của bài viết này.

Làm thế nào để bắt đầu

1. Nhận quyền truy cập vào API

Nếu bạn là khách hàng Thỏa thuận doanh nghiệp Webex Suite (Suite EA) đã kích hoạt Webex Events , thì bạn sẽ tự động có quyền truy cập vào API Webex Events ! Đối với tất cả các khách hàng khác, hãy liên hệ với người liên hệ Webex Events của bạn hoặc nhóm hỗ trợ của chúng tôi để tìm hiểu về cách truy cập API.

2. Tạo khóa API

Bây giờ bạn cần tạo khóa API mới để nhà phát triển của bạn sử dụng. Khi bạn có quyền truy cập vào API, một tab mới sẽ được thêm vào trang 'Cài đặt tổ chức' trong nền tảng Webex Events . Dưới đây là cách truy cập tab mới và tạo khóa đầu tiên của bạn:

💡 Xin lưu ý rằng chỉ quản trị viên của tổ chức mới có thể truy cập trang API.

  1. Từ bất kỳ đâu trong nền tảng Webex Events , hãy nhấp vào ảnh hồ sơ của bạn ở góc trên cùng bên phải màn hình, sau đó chọn Cài đặt tổ chức từ trình đơn thả xuống.

  2. Trên trang Cài đặt tổ chức, hãy nhấp vào tab API ở menu bên trái. Thao tác này sẽ đưa bạn đến trang tổng quan API nơi bạn có thể xem lại việc sử dụng API, xuất nhật ký sử dụng, quản lý khóa và truy cập tài liệu API của chúng tôi.

  3. Nhấp vào Tạo khóa .

  4. Trong phương thức 'Tạo khóa mới', hãy nhập Nhãn cho khóa API để giải thích mục đích sử dụng khóa đó.

  5. Trình đơn thả xuống phiên bản API sẽ có sẵn phiên bản hiện tại được chọn, vì vậy chỉ cần nhấp vào Lưu . Điều này sẽ tiết lộ khóa API.

  6. Nhấp vào nút Sao chép bên cạnh khóa và dán khóa vào tài liệu an toàn để đảm bảo nó không bao giờ bị mất.

    ⚠️ CẢNH BÁO! Đây là lần duy nhất có thể truy cập khóa API đầy đủ. Sau khi bạn đóng phương thức, không thể đọc lại toàn bộ khóa.

  7. Sau khi sao chép và lưu key xong, hãy nhấp vào nút Close .

Trong hầu hết các trường hợp, bạn chỉ cần một khóa API. Tuy nhiên, trong trường hợp bạn đang làm việc với nhiều nhóm, bạn có thể muốn tạo khóa cho mỗi nhóm. Nói chuyện với nhà phát triển của bạn về các trường hợp sử dụng cụ thể để tìm ra giải pháp tốt nhất.

3. Mời nhà phát triển truy cập API

Khi bạn tạo khóa API đầu tiên, một nhóm API mới sẽ tự động được tạo trong nền tảng Webex Events . Việc cấp cho nhà phát triển của bạn quyền truy cập để dùng thử API Webex Events cũng đơn giản như mời họ tham gia nhóm API đó. Hãy làm theo hướng dẫn trong bài viết của chúng tôi về cách quản lý nhóm, thành viên và tín dụng để tìm hiểu cách thực hiện.

💡 Hãy nhớ rằng hộp cát API là một phiên bản riêng biệt của nền tảng Webex Events được thiết kế đặc biệt để thử nghiệm. Điều này có nghĩa là tất cả thành viên mới của nhóm API Sandbox phải tạo tài khoản nền tảng mới để sử dụng sandbox, ngay cả khi họ đã có tài khoản nền tảng hoặc đăng nhập bằng SSO của tổ chức.

Những người trong nhóm API của bạn không có quyền truy cập vào phần còn lại của nền tảng Webex Events như cách người tổ chức thực hiện. Thay vào đó, các thành viên nhóm API có quyền truy cập vào "hộp cát" API nơi họ có thể kiểm tra những gì họ đang xây dựng mà không ảnh hưởng đến dữ liệu trong thế giới thực. Nếu bạn muốn nhà phát triển cũng có quyền truy cập vào một số hoặc tất cả Sự kiện và Ứng dụng thực của bạn trong nền tảng Webex Events , hãy mời họ tham gia các nhóm không phải API có liên quan.

4. Chuẩn bị sự kiện

Vì API không thể kích hoạt bất kỳ sản phẩm nào trong Sự kiện, chẳng hạn như Event App và Onsite, nên bạn phải kích hoạt từng sản phẩm bạn định sử dụng trong Sự kiện của mình, điền thông tin cơ bản được yêu cầu.

Làm việc với các nhà phát triển

Điều quan trọng là bạn phải giao tiếp rõ ràng với các nhà phát triển của mình để họ có thể xây dựng những gì bạn cần. Điều này có nghĩa là bạn cần biết API có thể truy cập những phần nào của nền tảng Webex Events . Hãy tiếp tục đọc để tìm hiểu chính xác những gì API có thể truy cập và kiểm soát, cùng với một số mẹo giúp bạn "nói cùng một ngôn ngữ" với nhà phát triển của mình.

Khi đã quen với các chức năng cơ bản, bạn có thể bắt đầu trao đổi với nhà phát triển của mình về các công cụ xây dựng và tự động hóa bằng API.

Các đội và tổ chức

  • Tạo, cập nhật, đọc và xóa nhóm và thành viên nhóm

Sự kiện

  • Tạo, cập nhật, sao chép và đọc. Sự kiện không thể bị xóa.

Người tham dự

  • Tạo, cập nhật, đọc, gán cho Phiên, gán cho nhóm và xóa thông tin tài khoản mạng xã hội (số điện thoại, số điều khiển tài khoản mạng xã hội, v.v.). Không thể xóa người tham dự, mặc dù họ có thể bị chặn.

Câu hỏi

  • Tạo, cập nhật, đọc và xóa

Mẹo: Trong API, các câu hỏi được gọi là "trường tùy chỉnh"

Các nhóm

  • Tạo, cập nhật, đọc và xóa cả nhóm độc quyền và không độc quyền

Phiên

  • Tạo, cập nhật, đọc và xóa

Địa điểm

  • Tạo, cập nhật, đọc và xóa

Mẹo: Trong API, vị trí được gọi là "khu vực".

Branded Apps

  • Đọc tên, trạng thái Branded App và tên của Sự kiện được chỉ định

Event App

  • Đọc cài đặt Thông tin cơ bản, Giao diện và Ứng dụng web cùng với thông tin Bản ghi Video Center

  • Tạo, cập nhật, đọc và xóa các tính năng sau Event App cũng như các mục trong đó, nếu có:

    • Chương trình nghị sự

    • Nhà tài trợ

    • Diễn giả

    • Nhà triển lãm

    • Trực tiếp

    • Người tham dự

    • Danh sách khách hàng

    • Một vật thể

    • Liên kết web

    • Danh sách web

    • Mã QR của tôi

💡 Xin lưu ý rằng bạn phải thêm và định cấu hình thủ công mọi tính năng Event App không được liệt kê ở trên.

Mẹo: Trong API, các tính năng được gọi là "thành phần".

Sự đăng ký

  • Đọc thông tin Cơ bản, Giao diện và Cài đặt, bao gồm cả cài đặt thanh toán

  • Tạo, đọc, cập nhật và xóa vé, biểu mẫu, câu hỏi, mã khuyến mãi

  • Tạo, đọc và cập nhật đơn hàng

  • Gửi email xác nhận đơn hàng và vé

  • Đánh dấu các đơn đặt hàng séc hoặc hóa đơn là đã thanh toán

  • Cập nhật thông tin người mua đơn hàng

  • Hủy và hoàn vé

  • Tạo, đọc, cập nhật, xóa, tạm dừng và tiếp tục mã khuyến mãi

  • Tạo, đọc, cập nhật và xóa thuế

Mẹo: Trong API, các câu hỏi được gọi là "trường tùy chỉnh".

Onsite

  • Đọc và cập nhật thông tin cơ bản và Onsite App

Lead Retrieval và Live Display

  • Đọc xem sản phẩm đang hoạt động hay được xuất bản trong Sự kiện

Những điều cần biết

  • Thỉnh thoảng chúng tôi sẽ phát hành các phiên bản API mới kèm theo các cải tiến và bản sửa lỗi. Chúng tôi sẽ tiếp tục hỗ trợ các phiên bản cũ đủ lâu để mọi người chuyển đổi sang phiên bản mới. Chúng tôi sẽ gửi thông tin cập nhật qua email về các phiên bản mới, ngày ngừng sử dụng phiên bản cũ sắp tới và thông tin ngừng sử dụng chính thức.

  • Các yêu cầu API được đo lường và giới hạn để ngăn chặn việc lạm dụng.

  • Cộng đồng cũng được hỗ trợ cho khách hàng Suite.

Nội dung này có giải đáp được câu hỏi của bạn không?