SigningHub Admin API Guide
Download OpenAPI specification:Download
Browse through the API content by selecting the relevant pages from the left panel. To quickly find specific web service information, enter search criteria in the search box on top left.
More about SigningHub
To know more about SigningHub, explore the following links:
- Go to SigningHub Knowledge Base to view all the relevant information of SigningHub.
-
Visit the Ascertia Community Portal to find answers to contact SigningHub support staff through the
Live Chat provision
.
Our
support staff may be occupied with other priority tasks so live chat is offered on
an "as available" basis.
This guide is intended for developers who will integrate SigningHub into their respective web applications using the RESTful web services, and user interface offered by SigningHub. It is assumed that the reader has a basic knowledge of REST, Java, C#, HTML, JavaScript, HTTP and TLS/SSL. There is no Software Developers Kit (SDK) for the integration, instead the integration uses HTML Forms and JSON so that integration is simple from any language including .Net, Java, PHP etc.
| Main Tags | Most Popular Pages |
|---|---|
|
➤
Welcome
➤ Prerequisites ➤ Access Token ➤ Updates ➤ APIs Developer Guide ➤ Appendix |
➤
Authentication
➤ Service Plans ➤ Account Management ➤ Billing Management ➤ Access Control ➤ Operator Logs ➤ Advanced Reports |
Base64-encoded client ID and client secret are used for authentication by passing a subject token obtained through TLS client authentication with a .pfx file. Upon successful validation of the certificate, a secure access token (e.g., JWT - JSON Web Token) is generated and returned. This token must be included in the Authorization header of all subsequent API requests to authorize access. The .pfx file used must belong to a SigningHub Administrator who is authorized to perform authentication and token generation operations.
Authentication
This API is used to obtain a subject token by passing a TLS .pfx file
header Parameters
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Responses
Response samples
- 200
- 500
{- "subject_token": "string"
}Password Authentication
This API is used to obtain access token by using grant_type, subject_token along with basic authorization contain encoded client ID and client secret.
header Parameters
| x-password | string Password required in case the password is required for authentication. |
| Authorization required | string Default: Basic {encoded_value} The client_id and client_secret are concatenated with a colon (:), then Base64-encoded. The resulting value is included in the Authorization header with the Basic prefix |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema: multipart/form-data
| subject_token | string A token that identify the authenticated user obtain from Authentication. |
| grant_type | string Define the OAuth 2.0 grant type. Default is "token-exchange". |
| refresh_token | string Refresh token required in grant type refresh_token. |
Responses
Response samples
- 200
- 400
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string"
}Set New Password
Business applications can use this service API to set a new password for admin.
header Parameters
| x-subject-token | string A token that identify the authenticated user obtain from Authentication. |
| Authorization required | string Default: Basic {encoded_value} The client_id and client_secret are concatenated with a colon (:), then Base64-encoded. The resulting value is included in the Authorization header with the Basic prefix |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| new_password | string or null new_password |
Responses
Request samples
- Payload
{- "new_password": "string"
}Response samples
- 200
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string"
}Forgot Password
Business applications can use this service API to send an email to recover password.
header Parameters
| x-subject-token | string A token that identify the authenticated user obtain from Authentication. |
| Authorization required | string Default: Basic {encoded_value} The client_id and client_secret are concatenated with a colon (:), then Base64-encoded. The resulting value is included in the Authorization header with the Basic prefix |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Responses
Response samples
- 200
- 403
- 500
{- "message": "string"
}Decrypt URL
Business applications can use this service API to decrpt url received in email.
header Parameters
| x-subject-token | string A token that identify the authenticated user obtain from Authentication. |
| Authorization required | string Default: Basic {encoded_value} The client_id and client_secret are concatenated with a colon (:), then Base64-encoded. The resulting value is included in the Authorization header with the Basic prefix |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| q | string or null query data string |
Responses
Request samples
- Payload
{- "q": "string"
}Response samples
- 200
- 403
- 500
[- {
- "number": true,
- "special_character": true,
- "upper_case": true,
- "minimum_length": 0
}
]Reset Password
Business applications can use this service API to reset password.
header Parameters
| x-subject-token | string A token that identify the authenticated user obtain from Authentication. |
| Authorization required | string Default: Basic {encoded_value} The client_id and client_secret are concatenated with a colon (:), then Base64-encoded. The resulting value is included in the Authorization header with the Basic prefix |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| new_password | string or null new_password |
Responses
Request samples
- Payload
{- "new_password": "string"
}Response samples
- 200
- 403
- 500
{- "message": "string"
}Logout
Business applications can call this API when a user logout from the application. This API call will update the user activity.
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Responses
Response samples
- 200
- 401
- 500
{- "message": "string"
}