Cisco WebEx Social API Reference Guide, Release 3.1
Preface
Downloads: This chapterpdf (PDF - 80.0KB) The complete bookPDF (PDF - 16.07MB) | Feedback

Preface

Table Of Contents

Preface

Audience

Organization

Obtaining Documentation, Obtaining Support, and Security Guidelines


Preface


This document provides information that is required to understand and use the Cisco WebEx Social release 3.0 RESTful application programming interface (API).

Audience

This document is intended for developers who want to use the Cisco WebEx Social API to control various Cisco WebEx Social features and functions and to access Cisco WebEx Social resources and data. It assumes that developers have knowledge or experience with Cisco WebEx Social, a web-level programming language, and the following:

Representational state transfer (REST) architecture

Extensible Markup Language (XML)

JavaScript Object Notation (JSON)

XML schema

Web services

Hyper Text Transport Protocol (HTTP) and Secure HTTP (HTTPS)

Organization

This document is organized as follows:

Chapter 1 "Introduction to the Cisco WebEx Social API"

Provides an overview of the Cisco WebEx Social API and provides general information that applies to the API operations

Chapter 2 "Authorization and Authentication"

Describes how the API uses the OAuth and xAuth protocols for authorization and authentication

Chapter 3 "Resources"

Describes the resources that are used in Cisco WebEx social API operations

Chapter 4 "User Resource Operations"

Provides detailed descriptions of the User resource operations

Chapter 5 "Community Resource Operations"

Provides detailed descriptions of the Community resource operations

Chapter 6 "Membership Request Resource Operations"

Provides detailed descriptions of the Membership request Resource operations

Chapter 7 "Post Resource Operations"

Provides detailed descriptions of the Post resource operations

Chapter 8 "Document File Resource Operations"

Provides detailed descriptions of the Document File resource operations

Chapter 9 "Document Folder Resource Operations"

Provides detailed descriptions of the Document Folder resource operations

Chapter 10 "File Resource Operations"

Provides detailed descriptions of the File resource operations

Chapter 11 "Configuration Operation"

Provides a detailed description of the Configuration operation

Chapter 12 "Mobile Client Operations"

Provides detailed descriptions of the Mobile Client operations

Chapter 13 "API Consumer Resource Operations"

Provides detailed descriptions of the API Consumer resource operations

Chapter 14 "API Client Resource Operations"

Provides detailed description of the API Client resource operation

Chapter 15 "Search Operation"

Provides a detailed description of the Search operations

Chapter 16 "Response Examples"

Provides examples of API responses for operations that return User, Community, CommunityCategory, Post, or relationship resources in the response payload


Obtaining Documentation, Obtaining Support, and Security Guidelines

For information about obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation. This publication also lists new and revised Cisco technical documentation. It is available at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html