@Scotty @W_deFazio I prepared a draft for a possible article. Just as a base for the discussion. What do you think? Thx, Esther
This article applies to all TeamViewer users who are interested in using the TeamViewer API.
Insert ToC
TeamViewer provides a web-based API that allows you to access data and control various aspects of your TeamViewer account.
You can use the API to develop apps that integrate TeamViewer functionality into your own corporate environment or you can develop apps that everyone can use.
For getting started with these possibilities and to benefit from this tool, we are explaining the TeamViewer API on a high level.
Requirements
To use the TeamViewer API you will need at least basic scripting knowledge.
Definitions
TeamViewer API
The TeamViewer API is RESTful and uses OAuth 2.0 for authentication and JSON for data communication. It uses the already existing HTTP methods to create (POST), read (GET), change (PUT), or delete (DELETE) single items or a collection of items.
The term API is an abbreviation and it stands for Application Programming Interface. An API is a set of commands, functions, protocols, and objects that programmers can use to create software or interact with an external system. It provides developers with standard commands for performing common operations so they do not have to write the code from scratch.
RESTful
The term REST is an abbreviation for REpresentational State Transfer. It describes how a system can communicate state with another system. Example: The state of a product (its name, description, etc.) represented as JSON, XML or plain text. The generalised idea of state is also called a resource. The term RESTful is typically used to refer to web services implementing the REST architecture.
OAuth2
The term OAuth is an abbreviation for Open Authorization and it is an open standard for token-based authentication and authorization on the Internet. With an update of this standard in 2010 it got the extention 2. OAuth2 provides users (like OAuth does) with the ability to grant third-party access to web resources without sharing a password.
JSON
The term JSON is an abbreviation for JavaScript Object Notation. It is an open-standard file format that uses human-readable text to transmit data objects consisting of attribute–value pairs and array data types (or any other serializable value).
HTTP
The term HTTP is an abbreviation for Hypertext Transfer Protocol. It is an application protocol for distributed, collaborative, and hypermedia information systems and it is the foundation of data communication for the Internet.
Simple Example script
In this script you will get to know all line functions
Script vs. Apps
In the TeamViewer API, two different ways of using the API are distinguished:
- Scripts: Apps are developed to be used for your own account only.
- Apps: Apps are developed to be used by many different accounts.
.
.
.
.
.
