웹엑스 이벤트 API로 시작하기

팀에 GraphQL API 사용법을 아는 개발자가 있다면, Webex Events API는 강력한 이벤트 및 제품 설정 및 관리 자동화, 타사 플랫폼 통합, 강력한 다중 이벤트 데이터 대시보드 등을 위한 게이트웨이가 될 수 있어요.

웹엑스 이벤트 API가 할 수 있는 일

간단히 말해서 API는 개발자들이 온라인 플랫폼 (여기서는 웹엑스 이벤트) 에서 데이터를 가져오거나 온라인 플랫폼에 데이터를 넣는 데 사용할 수 있는 프로그래밍 인터페이스예요.

API의 기능을 네 가지 기본 개념으로 단순화할 수 있어요.

참석자, 세션, 전체 이벤트 등 이전에 없던 것을 만드세요.
API를 사용하여 만들 수 있는 모든 것과 몇 가지를 더 업데이트하세요. 예를 들어 API를 사용하여 새 참석자를 만든 다음 참석자의 이름, 이메일, 상태, 그룹, 전화번호, 소셜 계정을 편집할 수 있어요.
API로 만들거나 편집할 수 있는 것들과 만들 수 없는 것들에 대한 정보를 읽어보세요.
API를 사용하여 만들 수 있는 모든 것을 삭제하세요. 몇 가지 예외가 있어요.

이 글의 '개발자와 함께 일하기' 섹션을 읽을 때 이 개념들을 염두에 두세요.

시작하는 방법이에요

1. API에 접속해 보세요.

이미 웹엑스 이벤트를 활성화한 Webex Suite 기업계약 (Suite EA) 고객인 경우, 자동으로 웹엑스 이벤트 API에 액세스할 수 있어요! 다른 모든 고객의 경우, Webex Events 담당자 또는 지원팀에 문의하여 API 액세스에 대해 알아보세요.

2. API 키 생성하세요.

이제 개발자들이 사용할 새 API 키를 만들어야 해요. API에 액세스할 수 있으면 웹엑스 이벤트 플랫폼의 '조직 설정' 페이지에 새 탭이 추가돼요. 새 탭에 액세스하고 첫 번째 키를 만드는 방법은 다음과 같아요.

명심하세요, 조직 관리자만 API 페이지에 접근할 수 있어요.

Webex Events 플랫폼의 아무 곳에서나 화면 오른쪽 상단에 있는 프로필 이미지를 클릭한 다음 드롭다운에서 조직 설정을 선택하세요.
조직 설정 페이지에서 왼쪽 메뉴의 API 탭을 클릭해요. 그러면 API 대시보드로 이동하여 API 사용을 검토하고, 사용 로그를 내보내고, 키를 관리하고, API 문서에 액세스할 수 있어요.
키 만들기 클릭해요.
'새 키 만들기' 모달에 API 키의 용도를 설명하는 라벨을 입력하세요.
API 버전 드롭다운에 이미 현재 버전이 선택되어 있을 거예요. 저장을 클릭하기만 하면 돼요. 그러면 API 키가 드러나요.
키 옆에 있는 복사 버튼을 클릭하고 키를 절대 분실하지 않도록 보안 문서에 붙여넣으세요.

경고해요!전체 API 키에 액세스할 수 있는 건 이번이 처음이에요.모달 닫은 후에는 전체 키를 다시 읽을 수 없어요.

키 복사해서 저장한 후 닫기 버튼 누르세요.

대부분의 경우 API 키가 하나만 필요해요. 하지만 여러 팀과 함께 일하는 상황에서는 각 팀마다 키를 만들고 싶을 수도 있어요. 최고의 솔루션을 찾으려면 개발자와 구체적인 사용 사례에 대해 이야기하세요.

3. API에 액세스하도록 개발자들을 초대하세요.

첫 API 키를 생성하면 웹엑스 이벤트 플랫폼에 새 API 팀이 자동으로 생성돼요. 개발자에게 Webex Events API를 시험해 볼 수 있는 액세스 권한을 부여하는 것은 해당 API 팀에 초대하기만 하면 돼요. 방법을 알아보려면 팀, 구성원, 크레딧 관리에 관한 기사의 지침을 따르세요.

명심하세요, API 샌드박스는 테스트용으로 특별히 만들어진 웹엑스 이벤트 플랫폼의 별도 버전이에요. 즉, API 샌드박스 팀의 모든 신입 구성원은 샌드박스를 사용하려면 새 플랫폼 계정을 만들어야 해요. 이미 플랫폼 계정이 있거나 조직 SSO로 로그인했더라도 말이죠.

당신의 API 팀원들은 오거나이저처럼 웹엑스 이벤트 플랫폼의 나머지 부분에 접근할 수 없어요. 대신 API 팀원들은 실제 데이터에 영향을 주지 않고 자신이 만들고 있는 것을 테스트할 수 있는 API “샌드박스”에 접속할 수 있어요. 개발자가 Webex Events 플랫폼에서 실제 이벤트 및 앱의 일부 또는 전부에 액세스할 수 있게 하려면 개발자를 관련 비 API 팀에 초대하세요.

4. 개발자들에게 친절하세요

이것은 매우 중요해요. 그래서 우리는 한 걸음씩 나아갔어요.😉

“로마는 하루아침에 세워지지 않았어요.” 그리고 API 통합도 잘 안 됐어요. 개발자들과 좋은 친구가 되어주고 통합 제공을 기대하기 전에 Webex Events API를 빠르게 익힐 수 있도록 충분한 시간을 주세요. 그들은 압박받지 않는 것에 감사할 거예요.

최소한 통합 작업이 필요하기 최소 6개월 전에 개발자와 대화를 시작하는 것이 좋아요.준비하고 대화를 나누는 방법을 배우려면 계속 읽으세요.

개발자들과 일해요

Webex Events 샌드박스 팀에 개발자를 초대하고 나서 가장 먼저 묻는 질문 중 하나가 “통합을 구축하는 데 시간이 얼마나 걸릴까요?”이 질문에 대한 답은 함께 일하는 개발자 수, 통합 작업에 걸리는 시간, 통합이 얼마나 복잡한지 등 여러 요인에 따라 달라져요.

통합을 설정하는 데 걸리는 시간은 개발자만이 알 수 있어요. 몇 가지 중요한 단계를 거쳐야 말이에요.

먼저 API가 무엇을 할 수 있는지 알아보려면 아래 섹션을 읽어보세요. 이렇게 하면 무엇이 가능한지 이해하는 데 도움이 돼서 개발자들과 요구 사항을 명확하게 전달할 수 있어요.
개발자와 만나고, API 문서를 공유하고, 원하는 것에 대해 논의하세요. 그들이 당신을 위해 할 수 있는 것과 할 수 없는 것에 대한 기본적인 피드백을 줄 수 있을 거예요. 하지만 웹엑스 이벤트 API에 익숙해지기 전까지는 구체적인 타임라인을 알려줄 수 없어요.
개발자들에게 API에 익숙해질 시간을 주세요. 이벤트, 데이터, Webex Events 플랫폼 등에 대한 개념적 또는 실제적인 질문에 답할 수 있도록 하세요.

API가 할 수 있는 일

API에는 두 가지 기본 기능이 있어요.

읽어보기 - Webex Events에서 데이터를 가져와서 검사하거나 다른 시스템으로 가져와요.
업데이트 - Webex Events에 데이터를 입력하여 새 항목을 만들거나 참석자 등의 데이터를 다른 플랫폼에서 동기화해요. Webex Events 플랫폼에서 무언가를 변경하는 것은 업데이트예요.

팀과 조직

팀과 팀원 생성, 업데이트, 읽기, 삭제하기

이벤트들

업데이트, 복제, 읽기. 이벤트는 API로 만들거나 삭제할 수 없어요.

참석자들

소셜 계정 정보 (전화번호, 소셜 계정 핸들 등) 생성, 업데이트, 읽기, 세션에 할당, 그룹에 할당, 삭제. 참석자는 차단할 수 있지만 삭제할 수는 없어요.

질문들

생성, 업데이트, 읽기, 삭제

팁: API에서는 질문을 “사용자 정의 필드”라고 해요.

그룹들

단독 그룹과 비독점 그룹 모두 생성, 업데이트, 읽기, 삭제하세요.

세션들

생성, 업데이트, 읽기, 삭제

위치들

생성, 업데이트, 읽기, 삭제

팁: API에서는 위치를 “지역”이라고 해요.

브랜드 앱

브랜드 앱 이름, 상태, 지정된 이벤트 이름을 읽어보세요.

이벤트 앱

기본 사항, 모양, Web App 설정과 비디오 센터 녹화 정보 읽어보세요.
해당되는 경우 다음 이벤트 앱 기능과 항목을 만들고, 업데이트하고, 읽고, 삭제하세요.
- 아젠다
- 스폰서들
- 스피커들
- 출품업체들
- 라이브 스트림이에요
- 참석자들
- 사용자 지정 목록
- 단일 아이템
- 웹 링크
- 웹 리스트
- 제 QR 코드예요

명심하세요, 위에 나열되지 않은 이벤트 앱 기능은 수동으로 추가하고 구성해야 해요.

팁: API에서는 기능을 “컴포넌트”라고 해요.

등록

결제 설정을 포함한 기본, 모양, 설정 정보 읽어보세요.
티켓, 양식, 질문, 프로모션 코드를 만들고, 읽고, 업데이트하고, 삭제하세요.
주문 생성, 읽기, 업데이트
주문 및 티켓 확인 이메일을 보내세요.
수표 또는 청구서 주문을 결제완료로 표시하세요.
주문 구매자 정보 업데이트
티켓 취소 및 환불
프로모션 코드 생성, 읽기, 업데이트, 삭제, 일시 중지, 재개하세요
세금 생성, 읽기, 업데이트, 삭제