APIs

Introduction to GlyphX APIs

GlyphX provides RESTful APIs for accessing all the functions. Here is a good introduction to RESTful APIs and is something which you should read before trying GlyphX APIs. The important points to remember about all GlyphX APIs is the following

• Everything is an asset and has its proper place in the API. That proper place is http://<base url>/<optional parent>/asset/. Typically that represents a collection of assets that you have access to. For example, http://glyphx.in/forms/ represents the collection of forms

• If you want to identify a specific member of a collection, you do it as follows http://<url to collection>/<id>. For example if you want to access a specific form you will do it as http://glyphx.in/forms/57ahdj7jh6khsdf9kah76788.

• Like all well behaved REST services GlyphX understands some verbs. The following verbs will be supported by most assets

  • GET - This is a read operation. If you do it on a collection, you will get a list of objects, if you do it on an object you will get the JSON representation of the object
  • POST - This is a do/create operation. If you do in most collections, it will create a new object of that collection with the information that you provided
  • PUT - This is a modify operation. You have to operate this on a specific object of a collection and it will be modified according to the information that you are providing
  • DELETE - This is a delete operation. You have to operate this on a specific object of a collection and it will be deleted

• All requests will responded by the standard HTTP Status Codes. For most cases, watch for 200 OK or 202 ACCEPTED for success

• All response and error data will be JSON and the structure will vary according to the API

Table of Contents

• Views
  • List View
  • Detail View
• Authentication
  • Login
  • Logout
• Forms
  • List Forms
  • Detail Form
  • Create
  • Delete