Using the Accela Construct API

Accela API provides resources to build citizen and agency apps using Civic Platform. Learn the following Accela API Basics:

■     API Authentication

■     HTTP Headers

■     Partial Response

■     Internationalization (I18N)

■     Pagination

■     Errors

■     Cross-Domain Requests

■     Escape Characters

■     API Naming Conventions

The Accela API follows standard W3C guidelines, for REST APIs, that use a simple set of verbs (that correspond to the HTTP methods GET, PUT, POST, and DELETE) to operate on a rich set of nouns (Accela Automation resources named by URIs). Accela augments the standard Accela API on the Accela Civic Platform with Accela-specific packages. The Accela Construct API supports synchronous and asynchronous operation.

GET and DELETE methods embed request parameters in the URI and do not use JSON request bodies. POST and PUT methods use the JSON bodies to handle requests and responses.

The system processes content files (documents or images) outside of JSON request/response bodies as byte streams.

 feedback | print