Integrating AR System forms with a third-party application by using the REST API
The REST API is a simple stateless architecture that runs over HTTP. AR System uses JavaScript Object Notation (JSON) format to transmit data between a server and a web application. The advantage of REST is having a limited number of operations for the interactions between clients and services.
The API is a web service that conforms to the architectural principles of Representational State Transfer (REST). Each API is called by issuing a standard HTTP request method.
The client issues the following standard HTTP request method to call an API:
- POST - Request to create new resources
- GET - Request to retrieve details of individual resources
- PUT - Request to modify a resource object
- DELETE - Request to remove the resources that are not needed
These HTTP request methods are more commonly known as the CRUD operations: Create, Read, Update, and Delete.
The AR System uses Jetty as a web server to service the REST API requests. You should use Secure Sockets Layer (SSL) certificates with the Jetty server to service the REST API requests.
Learning about the REST API
- Overview of the REST API
- Learning about the REST API
- General principles for using the REST API
- Examples of using the REST API to get, update, and delete an entry from a form
- Example of using the explain query REST API to get the ARJDBC query execution plan
- Example of using the REST API to retrieve menu details
- Example of using the REST API to retrieve field metadata
- Example of using the REST API to retrieve an attachment from a form
- Example of using the REST API to retrieve an association
- Example of using the REST API to merge entries
- Example of using the REST API to create an entry on a form
- Example of using the AR System Server REST API to impersonate a user
Using the REST API
- Syntax and schemes for the REST API
- Resources for the REST API
- General principles for using the REST API
- Error handling for the REST API
- Endpoints in AR REST API
- Access and authentication for the REST API
- Syntax and schemes for the REST API
- Resources for the REST API
- General principles for using the REST API
- Error handling for the REST API
- Endpoints in AR REST API
- Access and authentication for the REST API
Related topic