Building the API client library requires Maven to be installed.
To install the API client library to your local Maven repository, simply execute:
mvn install
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn deploy
Refer to the official documentation for more information.
Add this dependency to your project's POM:
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>openapi-android-client</artifactId>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>
Add this dependency to your project's build file:
compile "org.openapitools:openapi-android-client:1.0.0"
At first generate the JAR by executing:
mvn package
Then manually install the following JARs:
- target/openapi-android-client-1.0.0.jar
- target/lib/*.jar
Please follow the installation instruction and execute the following Java code:
import org.openapitools.client.api.GlobalCustomerApi;
public class GlobalCustomerApiExample {
public static void main(String[] args) {
GlobalCustomerApi apiInstance = new GlobalCustomerApi();
String pksCustomerCode = null; // String | The customer code assigned to your account
String sInfrastructureproductCode = null; // String | The infrastructure product Code If undefined, \"appcluster01\" is assumed
try {
GlobalCustomerGetEndpointV1Response result = apiInstance.globalCustomerGetEndpointV1(pksCustomerCode, sInfrastructureproductCode);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GlobalCustomerApi#globalCustomerGetEndpointV1");
e.printStackTrace();
}
}
}
All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
Class | Method | HTTP request | Description |
---|---|---|---|
GlobalCustomerApi | globalCustomerGetEndpointV1 | GET /1/customer/{pksCustomerCode}/endpoint | Get customer endpoint |
ModuleSsprApi | ssprResetPasswordRequestV1 | POST /1/module/sspr/resetPasswordRequest | Reset Password Request |
ModuleSsprApi | ssprResetPasswordV1 | POST /1/module/sspr/resetPassword | Reset Password |
ModuleSsprApi | ssprSendUsernamesV1 | POST /1/module/sspr/sendUsernames | Send username(s) |
ModuleSsprApi | ssprUnlockAccountRequestV1 | POST /1/module/sspr/unlockAccountRequest | Unlock Account Request |
ModuleSsprApi | ssprUnlockAccountV1 | POST /1/module/sspr/unlockAccount | Unlock Account |
ModuleSsprApi | ssprValidateTokenV1 | POST /1/module/sspr/validateToken | Validate Token |
ModuleUserApi | userCreateEzsignuserV1 | POST /1/module/user/createezsignuser | Create a new User of type Ezsignuser |
ObjectActivesessionApi | activesessionGetCurrentV1 | GET /1/object/activesession/getCurrent | Get Current Activesession |
ObjectApikeyApi | apikeyCreateObjectV1 | POST /1/object/apikey | Create a new Apikey |
ObjectEzsigndocumentApi | ezsigndocumentApplyEzsigntemplateV1 | POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate | Apply an Ezsign Template to the Ezsigndocument. |
ObjectEzsigndocumentApi | ezsigndocumentCreateObjectV1 | POST /1/object/ezsigndocument | Create a new Ezsigndocument |
ObjectEzsigndocumentApi | ezsigndocumentDeleteObjectV1 | DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID} | Delete an existing Ezsigndocument |
ObjectEzsigndocumentApi | ezsigndocumentGetChildrenV1 | GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getChildren | Retrieve an existing Ezsigndocument's children IDs |
ObjectEzsigndocumentApi | ezsigndocumentGetDownloadUrlV1 | GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType} | Retrieve a URL to download documents. |
ObjectEzsigndocumentApi | ezsigndocumentGetObjectV1 | GET /1/object/ezsigndocument/{pkiEzsigndocumentID} | Retrieve an existing Ezsigndocument |
ObjectEzsignfolderApi | ezsignfolderCreateObjectV1 | POST /1/object/ezsignfolder | Create a new Ezsignfolder |
ObjectEzsignfolderApi | ezsignfolderDeleteObjectV1 | DELETE /1/object/ezsignfolder/{pkiEzsignfolderID} | Delete an existing Ezsignfolder |
ObjectEzsignfolderApi | ezsignfolderGetChildrenV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getChildren | Retrieve an existing Ezsignfolder's children IDs |
ObjectEzsignfolderApi | ezsignfolderGetObjectV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID} | Retrieve an existing Ezsignfolder |
ObjectEzsignfolderApi | ezsignfolderSendV1 | POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send | Send the Ezsignfolder to the signatories for signature |
ObjectEzsignfoldersignerassociationApi | ezsignfoldersignerassociationCreateObjectV1 | POST /1/object/ezsignfoldersignerassociation | Create a new Ezsignfoldersignerassociation |
ObjectEzsignfoldersignerassociationApi | ezsignfoldersignerassociationDeleteObjectV1 | DELETE /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} | Delete an existing Ezsignfoldersignerassociation |
ObjectEzsignfoldersignerassociationApi | ezsignfoldersignerassociationGetChildrenV1 | GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/getChildren | Retrieve an existing Ezsignfoldersignerassociation's children IDs |
ObjectEzsignfoldersignerassociationApi | ezsignfoldersignerassociationGetInPersonLoginUrlV1 | GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/getInPersonLoginUrl | Retrieve a Login Url to allow In-Person signing |
ObjectEzsignfoldersignerassociationApi | ezsignfoldersignerassociationGetObjectV1 | GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} | Retrieve an existing Ezsignfoldersignerassociation |
ObjectEzsignsignatureApi | ezsignsignatureCreateObjectV1 | POST /1/object/ezsignsignature | Create a new Ezsignsignature |
ObjectEzsignsignatureApi | ezsignsignatureDeleteObjectV1 | DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID} | Delete an existing Ezsignsignature |
ObjectEzsignsignatureApi | ezsignsignatureGetChildrenV1 | GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getChildren | Retrieve an existing Ezsignsignature's children IDs |
ObjectEzsignsignatureApi | ezsignsignatureGetObjectV1 | GET /1/object/ezsignsignature/{pkiEzsignsignatureID} | Retrieve an existing Ezsignsignature |
ObjectFranchisebrokerApi | franchisebrokerGetAutocompleteV1 | GET /1/object/franchisebroker/getAutocomplete/{sSelector} | Retrieve Franchisebrokers and IDs |
ObjectFranchiseofficeApi | franchiseofficeGetAutocompleteV1 | GET /1/object/franchiseoffice/getAutocomplete/{sSelector} | Retrieve Franchiseoffices and IDs |
ObjectFranchisereferalincomeApi | franchisereferalincomeCreateObjectV1 | POST /1/object/franchisereferalincome | Create a new Franchisereferalincome |
ObjectPeriodApi | periodGetAutocompleteV1 | GET /1/object/period/getAutocomplete/{sSelector} | Retrieve Periods and IDs |
- ActivesessionGetCurrentV1Response
- ActivesessionGetCurrentV1ResponseMPayload
- AddressRequest
- ApikeyCreateObjectV1Request
- ApikeyCreateObjectV1Response
- ApikeyCreateObjectV1ResponseMPayload
- ApikeyRequest
- ApikeyRequestCompound
- ApikeyResponse
- AttemptResponse
- CommonAudit
- CommonGetAutocompleteV1Response
- CommonGetAutocompleteV1ResponseMPayload
- CommonResponse
- CommonResponseError
- CommonResponseObjDebug
- CommonResponseObjDebugPayload
- CommonResponseObjSQLQuery
- CommonWebhook
- ContactRequest
- ContactRequestCompound
- ContactRequestCompoundAllOf
- ContactinformationsRequest
- ContactinformationsRequestCompound
- EmailRequest
- EzsigndocumentApplyEzsigntemplateV1Request
- EzsigndocumentApplyEzsigntemplateV1Response
- EzsigndocumentCreateObjectV1Request
- EzsigndocumentCreateObjectV1Response
- EzsigndocumentCreateObjectV1ResponseMPayload
- EzsigndocumentDeleteObjectV1Response
- EzsigndocumentGetDownloadUrlV1Response
- EzsigndocumentGetDownloadUrlV1ResponseMPayload
- EzsigndocumentGetObjectV1Response
- EzsigndocumentGetObjectV1ResponseMPayload
- EzsigndocumentRequest
- EzsigndocumentRequestCompound
- EzsigndocumentResponse
- EzsigndocumentResponseAllOf
- EzsigndocumentResponseCompound
- EzsignfolderCreateObjectV1Request
- EzsignfolderCreateObjectV1Response
- EzsignfolderCreateObjectV1ResponseMPayload
- EzsignfolderDeleteObjectV1Response
- EzsignfolderGetObjectV1Response
- EzsignfolderGetObjectV1ResponseMPayload
- EzsignfolderRequest
- EzsignfolderRequestCompound
- EzsignfolderResponse
- EzsignfolderResponseAllOf
- EzsignfolderResponseCompound
- EzsignfolderSendV1Request
- EzsignfolderSendV1Response
- EzsignfoldersignerassociationCreateObjectV1Request
- EzsignfoldersignerassociationCreateObjectV1Response
- EzsignfoldersignerassociationCreateObjectV1ResponseMPayload
- EzsignfoldersignerassociationDeleteObjectV1Response
- EzsignfoldersignerassociationGetInPersonLoginUrlV1Response
- EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload
- EzsignfoldersignerassociationGetObjectV1Response
- EzsignfoldersignerassociationRequest
- EzsignfoldersignerassociationRequestCompound
- EzsignsignatureCreateObjectV1Request
- EzsignsignatureCreateObjectV1Response
- EzsignsignatureCreateObjectV1ResponseMPayload
- EzsignsignatureDeleteObjectV1Response
- EzsignsignatureGetObjectV1Response
- EzsignsignatureRequest
- EzsignsignatureRequestCompound
- EzsignsignerRequest
- EzsignsignerRequestCompound
- EzsignsignerRequestCompoundContact
- FieldEEzsigndocumentStep
- FieldEEzsignfolderSendreminderfrequency
- FieldEEzsignfolderStep
- FieldEPhoneType
- FieldEUserType
- FieldEUserTypeSSPR
- FranchisereferalincomeCreateObjectV1Request
- FranchisereferalincomeCreateObjectV1Response
- FranchisereferalincomeCreateObjectV1ResponseMPayload
- FranchisereferalincomeRequest
- FranchisereferalincomeRequestCompound
- GlobalCustomerGetEndpointV1Response
- MultilingualApikeyDescription
- PhoneRequest
- SsprResetPasswordRequestV1Request
- SsprResetPasswordV1Request
- SsprSendUsernamesV1Request
- SsprUnlockAccountRequestV1Request
- SsprUnlockAccountV1Request
- SsprValidateTokenV1Request
- UNUSEDEzsigndocumentEditObjectV1Request
- UNUSEDEzsigndocumentEditObjectV1Response
- UNUSEDEzsignfolderEditObjectV1Request
- UNUSEDEzsignfolderEditObjectV1Response
- UNUSEDEzsignfoldersignerassociationEditObjectV1Request
- UNUSEDEzsignfoldersignerassociationEditObjectV1Response
- UNUSEDEzsignsignatureEditObjectV1Request
- UNUSEDEzsignsignatureEditObjectV1Response
- UserCreateEzsignuserV1Request
- UserCreateEzsignuserV1Response
- UserCreateEzsignuserV1ResponseMPayload
- UserResponse
- UserResponseAllOf
- WebhookEzsignDocumentCompleted
- WebhookEzsignDocumentCompletedAllOf
- WebhookEzsignFolderCompleted
- WebhookEzsignFolderCompletedAllOf
- WebhookResponse
- WebhookUserUserCreated
- WebhookUserUserCreatedAllOf
- WebsiteRequest
Authentication schemes defined for the API:
-
Type: API key
-
API key parameter name: Authorization
-
Location: HTTP header
It's recommended to create an instance of ApiClient
per thread in a multithreaded environment to avoid any potential issues.