Legisway API Integrations: Technical Overview
The Legisway APIs provide REST services to search, load, update, and delete business data in a Legisway application.
All services are JSON REST services, and require the following headers:
- "Accept" must be "json/application" for each service that returns a JSON result
- “Content-Type" must be "json/application" for each service that receives a JSON request
- "Authorization" must be a bearer token retrieved from the Authentication API
Authentication API - When calling any service of the Legisway APIs, a token that provides the authentication must be provided. This token is a JSON Web Token (JWT), which can be obtained through the authentication API. This token must be sent in the headers of each HTTP request in the Authorization header, following a "Bearer" prefix.
Search API - The Search API provides a service that can search for contents of a specified type. The result is an array of rows. The rows are the extraction of the field and data that match the request for the specified page. The structure of each row depends on the fields that are defined and their internal structure.
Content API - The content API provides REST services to load, update, create, or delete content. Loading a content service loads the content that has the specified ID. It extracts the fields that are specified (or only the "_id", "_title" and "_type" fields when the fields are not specified).
File Transfer API - The File API provides REST services to load and add files in the database. Legisway provides an end-point to list all the files of content and an end-point to download a file. To extract files, the first step is to identify the files that are defined on a content. The ID of the content must be known (usually after a call to the Search API).
