Authorization of the API Access

Steps to Register a Client Application

To initiate the registration of a client application with Evia Sign, the client is required to initiate contact with the Evia Sign team through email. During this communication, the client should provide their designated redirect URL for their external application, which serves as a crucial component for the registration process.

Upon successful communication and collaboration with the Evia Sign team, the client's application will be formally registered. Subsequently, the client will receive their unique Client ID and Client Secret, which are essential credentials for authentication and authorization processes.

It is imperative to note that the client's redirect URL, which was initially shared, plays a pivotal role in the overall process.

Following a successful login event, the OAuth code will be returned to the specified redirect URL, facilitating seamless integration and interaction between the client's application and the Evia Sign platform.

Key Parameters:

• client_id: The Application ID assigned by the Evia Sign developer team during the registration process.

• client_secret: The Application Key provided by the Evia Sign developer team for secure access and authentication.

• redirect_url: The URL specified by the client during registration, to which the OAuth code will be returned upon successful login.

Obtaining Authorization for Evia Resources

To obtain authorization, utilize the assigned client ID and client secret to acquire the authorization URL from the system. When requesting an access token and refresh token, specify the grant type as 'authorization code.'

The resulting access token facilitates access to Evia resources through the Evia API. As this process involves a redirection-based flow, it is imperative that the client possesses the capability to engage with the resource owner's user-agent, typically a web browser.

Furthermore, the client should be equipped to receive incoming requests, particularly through redirection, from the authorization server.

The EVIA-IDENTITY-PROVIDER (EIP)

This serves as the central system responsible for furnishing user identifiers for interactions with Evia. EIP takes charge of user authentication, maintaining a comprehensive record of user login details. It also oversees the management of Enadoc organization information and user data. To engage with Evia resources via the Evia API, clients need to possess both the Evia website URL and the EIP URL. This ensures proper access and authentication for seamless integration with Evia services.

Refer to the provided image for the Evia Sign SaaS app URL to gain an understanding of the associated EIP URL:

EIP URL

Get Authorization URL

After obtaining the client ID and client secret, you can proceed to construct the client authorization URL using the specified format.

Utilize your assigned client ID and redirect URL in accordance with the provided guidelines to generate the authorization URL.

This URL serves as the Authorization URL, allowing you to input your unique Client ID and the Redirect URL for authentication purposes.

https://evia.enadocapp.com/_apis/falcon/auth/oauth2/authorize?application_state=external&resource=RESOURCE_APPLICATION&client_id={client_id}
&responce_type=code&redirect_uri={redirectURL}

Error Messages

Error	Error Decription
If access token is invalid	Invalid access token
If access token is expired	Access token is expired
If user does not exist in the system	User does not exist in the system. Please contact administrator
If network error occurred	Error! Please check your internet connection and try again.

Get Access Token

This endpoint, activated by a GET request to the designated URL with the access token included as a header, facilitates the retrieval of the access token for Evia Sign. Upon successful execution, it responds with a status code of 200 and presents the login page.

POST https://evia.enadocapp.com/_apis/falcon/auth/api/v1/Token

Headers

Name	Type	Description
Authorization	Bearer	Access token should be sent as request header

200: OK

If the request proceeds successfully, you will receive status code 200 with the login page to Evia Sign.

Request Body

Upon a successful request to obtain the Access Token, the API provides a response containing relevant information, including the access token and additional details.

Here's a breakdown of the response body:

{
       "client_id":"<Client ID>",
       "client_secret":"<Client Secret>",
       "code":"<code>",
       "grant_type":"authorization_code"
 }

Response Body

{
    "authToken": "Auth Token",
    "refreshToken": "Refresh Token"
}

Refresh Token

Triggered by a GET request to the specified URL, accompanied by the access token as a header, this endpoint is designed to refresh the access token for Evia Sign. Upon successful execution, it responds with a status code of 200, providing access to the login page, and issues a refresh token for future utilization

POST https://evia.enadocapp.com/_apis/falcon/auth/api/v1/Token

Headers

Name	Type	Description
Authorization	Bearer	Access token should be sent as request header

200: OK

If the request proceeds successfully, you will receive status code 200 with the login page to Evia Sign.

Request Body

{
       "client_id":"<Client ID>",
       "client_secret":"<Client Secret>",
       "refresh_token":"'Refresh Token'",
       "grant_type":"refresh_token"
 }

Response Body

Upon a successful request to refresh the access token, the API provides a response containing relevant information, including the refreshed access token and additional details.

Here's a breakdown of the response body:

{
    "authToken": "Auth Token",
    "refreshToken": "Refresh Token"
}