Zamples Client REST Interface Specification

You can easily write a client program that communicates with a Zamples server.  The client can interact with a user to cause selected code examples to be compiled and executed on the Zamples server, and the results displayed to the user.  Code can also be stored in a Zamples knowledge base, or in an HTML button.

Each of the different functions of a typical client are discussed separately below.  Although Zamples supports a web services interface, we will instead illustrate the simpler HTML interface.

The functions described in this document are for authors and moderators of pre-existing knowledgeBases. Creating, updating and deleting KnowledgeBases is done through an administrative interface for publishers, and is not available to code example authors or moderators.

Terms of Service

Zamples, Inc. does not charge for executing low volumes of code examples for non-commercial purposes.  If you use this free public client interface to execute code exampes, you implicitly agree to the following terms; commercial customers will be bound by different terms.  Violators may be banned.

• All permanently stored code examples that are executed through the client interface must be accessible at no charge to the general public.
• Code example execution is logged and the examples may be provided to the public by Zamples, Inc.
• Each client must identify itself by a unique string as described in the HTTP user-agent header instructions.
• No promise of availability of the service is made.
• The client API may change without notice.
• These terms may change without notice.

Contents

Release notes.

Detailed documentation for writing your own Zamples client follows:

Zamples Client HTTP User-Agent Strings
Common Aspects of REST Calls
Controlling the Range of Lines Displayed for a Posting
Sandbox Discovery
Execution of Arbitrary Code
Listing Arbitrary Code
Creation of an HTML "Try It!" Button
Querying Code Examples in a Knowledge Base
Execution of Code from a Knowledge Base
Listing of Code in a Knowledge Base
Saving a New Posting to a Knowledge Base
Modifying a Posting in a Knowledge Base
Deleting a Posting From a Knowledge Base