On 19th November 2024 it will be dismissed.
The documentation is available in the new Confluence Site: - https://namirial.atlassian.net/wiki
...
Table of Contents | ||||
---|---|---|---|---|
|
Section |
---|
AuthorizationThis section covers a REST-integration. For the authorization you need the OrganizationKey and the UserLoginName of your organization. You can find this two keys in Settings->Organization. If you are authorized you will get a HTTP/200 Ok info. Otherwise you will get a 401 Unauthorized error. CallbacksThe API allows the definition of several callbacks. Please note, that only the envelope callback (directly from eSignAnyWhere) is fired, when the envelope is in a final state. The status update callback is fired by a sub-component and you may require to wait a post-processing time that the envelope reaches its final state. Envelope CallbackThis is the basic callback (“CallbackUrl”: “”), which is fired if the envelope reaches a final state (completed, rejected). If you integrate eSAW, please have a look at the Envelope Status Callback (directly below documented), because it might deliver more details about the envelope and might so be more useful for integrating. Placehoder
Sample: https://www.mycallback.at?envelope=##EnvelopeId## Envelope Status CallbackEnvelopes status callbacks (“StatusUpdateCallbackUrl”: “”,) are fired, based on envelope events/actions. There are also detailed callbacks available based on events. Consider, that our system expects the full callback url, including the parameter list you expect, with the placeholders that should be replaced by values at runtime. You can also add your own paramter for that envelope (e.g. internal references). Moreover, on our shared SaaS environments only HTTPS (port 443) callbacks are allowed. Placehoder for callback URL:
Consider, that our system expects the full callback url, including the parameter list you expect, with the placeholders that should be replaced by values at runtime. You can also add your own paramter for that envelope (e.g. internal references). Moreover, on our shared SaaS environments only HTTPS (port 443) callbacks are allowed. Sample: https://www.mycallback.at?envelope=##EnvelopeId##&action=##Action## Sample with custom parameter “internalid“: https://www.mycallback.at?envelope=##EnvelopeId##&action=##Action##&internalid=1234 Draft CallbacksDraft callbacks are fired, if a draft is used or deleted. The draft callback is set in the “CreateDraftOptions” (“AfterSendCallbackUrl”: “”), via the following call: https://demo.xyzmo.com/Api/v4.0/envelope/create
Sample: https://www.mycallback.at?draft=##DraftId## ErrorIn general, our REST endpoint returns different HTTP status codes:
|
...