이 기사는 기계 번역을 사용하여 영어에서 번역되었습니다.
GraphQL API 사용 방법을 알고 있는 개발자가 팀에 있는 경우, Webex Events API는 강력한 이벤트 및 제품 설정과 관리 자동화, 제3자 플랫폼 통합, 강력한 멀티 이벤트 데이터 대시보드 등에 대한 게이트웨이가 될 수 있습니다. .
Webex Events API가 할 수 있는 작업
간단히 말하면, API는 개발자가 온라인 플랫폼(이 경우 Webex Events)에서 데이터를 가져오거나 온라인 플랫폼에 데이터를 넣는 데 사용할 수 있는 프로그래밍 인터페이스입니다.
API의 기능은 다음 네 가지 기본 개념으로 단순화될 수 있습니다.
참석자, 세션 또는 전체 이벤트와 같이 이전에는 존재하지 않았던 것을 만듭니다 .
API를 사용하여 생성할 수 있는 모든 항목과 몇 가지 추가 사항을 업데이트하세요 . 예를 들어 API를 사용하여 새 참석자를 만든 다음 해당 참석자의 이름, 이메일, 상태, 그룹, 전화번호 및 소셜 계정을 편집할 수 있습니다.
API를 사용하여 생성하거나 편집할 수 있는 모든 항목과 사용할 수 없는 항목에 대한 정보를 읽어보세요 .
몇 가지 예외를 제외하고 API를 사용하여 생성할 수 있는 모든 항목을 삭제합니다 .
이 문서의 '개발자와 작업하기' 섹션을 읽는 동안 이러한 개념을 염두에 두십시오.
시작하는 방법
1. API에 액세스하세요
이미 Webex Events 활성화한 Webex Suite 기업 계약(Suite EA) 고객인 경우, Webex Events API에 자동으로 액세스하게 됩니다! 다른 모든 고객의 경우 Webex Events 담당자 또는 지원 팀에 문의하여 API 액세스에 대해 알아보십시오.
2. API 키 생성
이제 개발자가 사용할 새로운 API 키를 생성해야 합니다. API에 대한 액세스 권한이 있으면 Webex Events 플랫폼의 '조직 설정' 페이지에 새 탭이 추가됩니다. 새 탭에 액세스하고 첫 번째 키를 만드는 방법은 다음과 같습니다.
💡 조직 관리자만 API 페이지에 액세스할 수 있다는 점을 명심하세요.
Webex Events 플랫폼 어디에서나 화면 오른쪽 상단에 있는 프로필 이미지를 클릭한 후 드롭다운에서 조직 설정을 선택합니다.
조직 설정 페이지의 왼쪽 메뉴에서 API 탭을 클릭합니다. 그러면 API 사용량을 검토하고, 사용 로그를 내보내고, 키를 관리하고, API 문서에 액세스할 수 있는 API 대시보드로 이동됩니다.
키 생성 을 클릭합니다.
'새 키 만들기' 모달에서 API 키의 용도를 설명하는 라벨을 입력하세요.
API 버전 드롭다운에는 이미 현재 버전이 선택되어 있으므로 저장을 클릭하기만 하면 됩니다. 그러면 API 키가 드러납니다.
키 옆에 있는 복사 버튼을 클릭하고 보안 문서에 키를 붙여 넣어 분실되지 않도록 하세요.
⚠️ 경고! 전체 API 키에 액세스할 수 있는 유일한 시간입니다. 모달을 닫은 후에는 전체 키를 다시 읽을 수 없습니다.
키를 복사하여 저장한 후 닫기 버튼을 클릭하세요.
대부분의 경우 API 키는 하나만 필요합니다. 그러나 여러 팀과 협력하는 상황에서는 각 팀에 대한 키를 생성할 수 있습니다. 최상의 솔루션을 찾으려면 특정 사용 사례에 대해 개발자와 대화하세요.
3. 개발자를 초대하여 API에 액세스하세요.
첫 번째 API 키를 생성하면 Webex Events 플랫폼에 새로운 API 팀이 자동으로 생성됩니다. 개발자에게 Webex Events API를 사용해 볼 수 있는 액세스 권한을 부여하는 것은 해당 API 팀에 초대하는 것만큼 간단합니다. 방법을 알아보려면 팀, 구성원 및 크레딧 관리에 대한 도움말의 지침을 따르세요.
💡 API 샌드박스는 테스트용으로 특별히 제작된 Webex Events 플랫폼의 별도 버전이라는 점을 명심하십시오. 즉, API 샌드박스 팀의 모든 신규 구성원은 이미 플랫폼 계정이 있거나 조직의 SSO로 로그인한 경우에도 샌드박스를 사용하려면 새 플랫폼 계정을 만들어야 합니다.
API 팀의 사람들은 주최자처럼 Webex Events 플랫폼의 나머지 부분에 액세스할 수 없습니다. 대신 API 팀 구성원은 실제 데이터에 영향을 주지 않고 구축 중인 항목을 테스트할 수 있는 API "샌드박스"에 액세스할 수 있습니다. 개발자가 Webex Events 플랫폼에서 실제 이벤트 및 앱의 일부 또는 전체에 액세스할 수 있도록 하려면 해당 비API 팀에 해당 개발자를 초대하십시오.
4. 이벤트 준비
API는 Event App , Onsite 이벤트의 어떤 제품도 활성화할 수 없으므로 이벤트에 사용하려는 각 제품을 활성화하고 기본 필수 정보를 입력해야 합니다.
개발자와 협력
개발자가 필요한 것을 구축할 수 있도록 개발자와 명확하게 소통하는 것이 중요합니다. 이는 API가 액세스할 수 있는 Webex Events 플랫폼의 어떤 부분을 알아야 함을 의미합니다. API가 액세스하고 제어할 수 있는 것이 정확히 무엇인지 알아보고 개발자와 "동일한 언어를 사용"하는 데 도움이 되는 몇 가지 팁을 알아보려면 계속 읽어보세요.
기본 기능에 익숙해지면 API를 사용한 도구 및 자동화 구축에 관해 개발자와 대화를 시작할 수 있습니다.
팀 및 조직
팀 및 팀 구성원 생성, 업데이트, 읽기 및 삭제
이벤트
생성, 업데이트, 복제 및 읽기. 이벤트는 삭제할 수 없습니다.
참석자
생성, 업데이트, 읽기, 세션 할당, 그룹 할당 및 소셜 계정 정보(전화번호, 소셜 계정 핸들 등) 삭제. 참석자는 차단될 수 있지만 삭제할 수는 없습니다.
질문
생성, 업데이트, 읽기 및 삭제
팁: API에서는 질문을 "사용자 정의 필드"라고 합니다.
여러 떼
배타적 그룹과 비독점 그룹 모두 생성, 업데이트, 읽기 및 삭제
세션
생성, 업데이트, 읽기 및 삭제
위치
생성, 업데이트, 읽기 및 삭제
팁: API에서는 위치를 '지역'이라고 합니다.
Branded Apps
Branded App 이름, 상태 및 할당된 이벤트 이름을 읽습니다.
Event App
기본 사항, 모양, 웹 앱 설정 및 Video Center 녹화 정보를 읽어보세요.
해당하는 경우 다음 Event App 기능과 해당 항목을 생성, 업데이트, 읽기 및 삭제합니다.
의제
후원자
스피커
전시업체
라이브 스트림
참석자
맞춤 목록
단품
웹 링크
웹 목록
내 QR 코드
💡 위에 나열되지 않은 Event App 기능을 수동으로 추가하고 구성해야 한다는 점을 명심하세요.
팁: API에서는 기능을 "구성요소"라고 합니다.
등록
결제 설정을 포함한 기본 사항, 모양 및 설정 정보를 읽어보세요.
티켓, 양식, 질문, 프로모션 코드 생성, 읽기, 업데이트 및 삭제
주문 생성, 읽기, 업데이트
주문 및 티켓 확인 이메일 보내기
수표 또는 송장 주문을 결제 완료로 표시
주문 구매자 정보 업데이트
티켓 취소 및 환불
프로모션 코드 생성, 읽기, 업데이트, 삭제, 일시중지 및 재개
세금 생성, 읽기, 업데이트 및 삭제
팁: API에서는 질문을 "사용자 정의 필드"라고 합니다.
Onsite
기본 사항 및 Onsite App 정보를 읽고 업데이트하세요.
Lead Retrieval 및 Live Display
제품이 활성 상태인지 또는 이벤트에 게시되었는지 확인
알아야 할 사항
때때로 개선 사항과 수정 사항이 포함된 새 버전의 API를 출시할 예정입니다. 우리는 모든 사람이 새 버전으로 전환할 수 있을 만큼 오랫동안 이전 버전을 계속 지원할 것입니다. 새 버전, 예정된 이전 버전 지원 중단 날짜, 공식 지원 중단에 대한 업데이트를 이메일로 보내드리겠습니다.
API 요청은 남용을 방지하기 위해 측정되고 제한됩니다.
Suite 고객에게는 커뮤니티도 지원됩니다.