SwiftEnterprise -
Web Services API

REST API Web Services

You can use SwiftEnterprise REST APIs as service endpoints to interact with SwiftEnterprise Application remotely and perform various functions.

Platform

The link https://saas.digite.com/rest/v1/  takes you to the Swagger document to access different services. These web services can be used on any operating system and any web service client capable of handling REST API protocol.

For example, to view the list of operations that can be performed on an eForm, you can click EFormService. It opens the Swagger page where you can access all services related to the eForm operations.

Authentication

The authentication method for the REST APIs is token-based authentication using JWT Token or using Personal SwiftEnterprise LoginID. 

In case of JWT based authentication, a token is generated for a user-specified time interval. To access any of the REST web services you must first generate the Authentication Token.

Generating JWT Authentication Token 

To get an Authentication Token in SwiftEnterprise, perform the following steps:

  1. Navigate to the User Profile panel and select the “My Profile” option.
  2. Click the ‘Generate Token’ icon on the toolbar.
  3. In the Generate Authentication Token window, enter the date in the Expiry Date field. (Note: Once that specified date is over, you will again have to generate a new token.)
  4. You can generate as many tokens as you want, but once you create a token and close the window, you won’t be able to see it again on the screen.

Generating  Authentication Token using Personal SwiftEnterprise LoginID 

You can generate an Authentication Token using your personal SwiftEnterprise LoginID.

Since this method accepts Encrypted Password, an UI page will be provided (It will be provided by Digite support on request), which will accept plain text password and create an encrypted password. It will use a 64 bit DES (Data Encryption Standard) Encryption method to encrypt the password.

Pass the Loginid and Encrypted Password as a part of the body to call the TokenService. The resulting output string is returned in the response body as the data element, which is one of the several name/value paired objects in a data collection. Make sure that the user for which you are generating a personal access token is having enough access to perform the activities. Following is the snippet of the sample call to generate the personal SwiftEnterprise ID token.

SwiftEnterprise ID token

The following snippet shows the generated Authentication Token as part of the response body. The response body contains a data element, which should be passed as header to call all the SwiftEnterprise REST web services.

SwiftEnterprise REST web services

Components of a REST API Request/Response Pair

A REST API request/response pair can be separated into the following components:

  1. The request URI, in the following form :

https://{host:port}/rest/v1/api/{ParentService}/{ServiceName}/{Params1}/{param2}/..

example:

https://saas.digite.com/rest/v1/api/EFormService/getEFormItemData/Prj/SWFT000003SwiftEnter/UST1

2. HTTP request message header fields:

  • A required HTTP method (also known as an operation), which tells the service what type of operation you are requesting. SwiftEnterprise REST APIs support GET, PUT, POST and DELETE methods.
  • Additional header fields, as required by the specified URI and HTTP method. For example, an AuthorizationToken header that provides a bearer token containing client authorization information for the request.
  1. Optional HTTP request message body fields, to support the URI and HTTP operation. For example, POST operations contain MIME-encoded objects that are passed as complex parameters.
  • For POST or PUT operations, the MIME-encoding type for the body should also be specified in the Content-type request header.
  • SwiftEnterprise web service accepts content-type as JSON (application/json).
  1. HTTP response message header fields:
  • An HTTP status code, ranging from 2xx success codes to 4xx or 5xx error codes.
  • Optional additional header fields, as required to support the request’s response, such as a Content-type response header.
  1. Optional HTTP response message body fields:
  • MIME-encoded response objects may be returned in the HTTP response body, such as a response from a GET method that is returning data. Typically, these objects are returned in a structured format such as JSON, as indicated by the Content-type response header. For example, when you request an access token from SwiftEnterprise, it will be returned in the response body as the data element, one of several name/value paired objects in a data collection.

SwiftEnterprise REST web service exposes API to allow users to perform common card operations as listed below:

SwiftEnterprise Rest API

Manage your Digital Transformation and DevOps Projects Effectively!

Request for a customized SwiftEnterprise Demo!

Request Demo