Version: v1
\nAccessibility Fix is a suite of APIs developed by CodeMantra for generating accessible documents from unaccessible ones by using Machine Learning and some logic based heuristics.
\nOnce registered with CodeMantra for AccessibilityFix API suite, you can use below APIs for seamless integration into your products:
\n* Authorize
* Accessibility Fix Request
* File or URL
* Generate Prediction JSONs (and Tagged PDF)
* Accessibility Fix Status
For password management, you can use below APIs:
\n* Change Password
* Forgot Password
* Password Policy
* Minimum password length should be 8
* Numbers are required
* Special characters are required
* Uppercase letters are required
* Lowercase letters are required
* The temporary password sent on registration will be valid for 365 days.
* The temporary password sent on registration will be valid for 365 days.
request_id to track your upload request.generateTaggedOutput JSON object as false.info JSON object. The information will be added to the file data as such.\n\nThe accessible version of the document will be only available for download till 7 days from the time the Accessibility Fix request was received.
\n
Additionally, Accessibility Fix API provides a websocket connect feature using which you can connect to receive real-time remediation status notifications. If you happen to use the websocket connect feature, you'll not need to keep track of you requests by continuously polling Accessibility Fix Status API.
\nYou can connect to the websocket using the below url:
\nwss://accessibilityfix.ws.codemantra.com?Authorization=[your-access-token]\n\nvar WebSocketClient = require(\"websocket\").client\nvar client = new WebSocketClient();\nclient.on('connectFailed', function(error) {\n console.log('Connect Error: ' + error.toString());\n});\nclient.on('connect', function(connection) {\n console.log('WebSocket Client Connected');\n connection.on('error', function(error) {\n console.log(\"Connection Error: \" + error.toString());\n });\n connection.on('close', function() {\n console.log('Connection Closed');\n });\n connection.on('message', function(message) {\n const content = JSON.parse(message.utf8Data);\n if (content.event == 'accessibility-fix-complete') {\n console.log('Recieved new accessibility-fix-complete notification');\n console.log(content)\n // Add your business logic here\n }\n });\n});\n// Obtain valid token from Authorize API\nconst token = \"[your-access-token]\";\nclient.connect('wss://accessibilityfix.ws.codemantra.com?Authorization='+token);\n\nAPI for retrieving authorization token for a registered user.
\ntoken provided in the response should be used as Authorization Header in other APIs.\n
\n
API for uploading a document for accessibility remediation process to be performed on the uploaded document. Document uploads can be either direct (no documentUrl field in request), or via URL (documentUrl field contains file url value).
In case of direct document uploads, response body will contain uploadUrl field using which document can be uploaded for accessibility remediation process.
Following options are valid for format field:
API for retrieving accessibility remediation process status of a particular uploaded document.
\nAPI to change a user's password.
\nAPI to request password reset, in case the user has forgotten his current password.
\nOnce the request is received, a mail will be sent to the user's registered email with the verification code for the password reset. The verification code can then be used in the Reset Password API to reset the user password.
\nAPI to reset a user's password.
\nIf a user has requested password reset, a verification code will be sent to the registered email. The user can then use this API to reset his password by passing the confirmation code along with the new password.
\n