Using the Accela 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 the standard HTTP methods GET, PUT, POST, and DELETE to operate on a rich set of Civic Platform object resources. The Accela 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. All methods return data in JSON response bodies.

The system processes content files (such as document or image attachments) outside of JSON request/response bodies as byte streams.