MXPROCESS

    This API is simple to use. You just have to follow these steps

• Create a free account
• Click on the link you receive by email to confirm your address
• Generate a token with credentials

You can use any language to make this CURL call. (Python, PHP, Java, JavaScript...) Need help ?

curl --location --request POST 'http://mxprocess.com/api/login_check' \ --header 'Content-Type: application/json' \ --data-raw '{"username":"YOUR_LOGIN","password":"YOUR_PASSWORD"}'

If your credentials are correct, our server will provide you with a token as a response : {"token": "YOUR_TOKEN","refresh_token": "YOUR_REFRESH_TOKEN"}
YOUR_TOKEN is valid for one hour, its duration can be extended using YOUR_REFRESH_TOKEN


• Use the token to start the process asynchronously
curl --location 'http://mxprocess.com/api/files/start-process' \ --header 'Authorization: Bearer YOUR_TOKEN' \ --form 'file=@"/FILE_PATH/FILE_NAME"' \ --form 'actionName="ZipFile"' \ --form 'parameters="[]"' \ --form 'fileUrl=""' \ --form 'fileContent=""'
If your file is accessible by URL, you can ignore the "file=@.." field and directly use the URL of your file in the "fileUrl" field

The API sends you a Json response to confirm that the process has started. take note of the "trackingUrl" field, it is the one that allows you to follow the process that you have launched. In this answer you also find the ID of your process, here in our example the ID is 643 : { "id": 643, "actionParameters": [], "dateOfDemand": "2024-01-28T11:03:25+01:00", "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "ZipFile", "slug": "create-zip-file-online", "jsonRequestSample": null, "jsonResponseSample": null, "specificDeveloperRequestDocumentation": null, "specificDeveloperResponseDocumentation": null, "longDescription": null }, "user": [], "accomplished": false, "userIsNotifiedByEmail": "off", "userIsNotifiedByPostQuery": "off", "actionResults": [], "priceInTokensAtTimeOfUse": 3, "retryCount": 0, "trackingUrl": "http://mxprocess.com/api/actions/get-action-infos/643" }


• So to follow the progress, you do a simple GET(you can make this http call every 10 seconds):
curl --location 'http://mxprocess.com/api/actions/get-action-infos/643' \ --header 'Authorization: Bearer YOUR_TOKEN' }}

If the process is not yet completed, you will receive this type of response with "accomplished": false { "id": 643, "actionParameters": [], "dateOfDemand": "2024-01-28T11:03:25+01:00", "startTime": null, "endTime": null, "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "ZipFile", "slug": "create-zip-file-online", "jsonRequestSample": null, "jsonResponseSample": null, "specificDeveloperRequestDocumentation": null, "specificDeveloperResponseDocumentation": null, "longDescription": null }, "user": [], "accomplished": false, "userIsNotifiedByEmail": "off", "userIsNotifiedByPostQuery": "off", "actionResults": [], "priceInTokensAtTimeOfUse": 3, "retryCount": 0, "executionPlannedAt": null, "trackingUrl": "" }

If the process is completed, you will receive this type of response with "accomplished": true and an actionResults field that contains the results: { "id": 643, "actionParameters": { "commandParameters": "" }, "dateOfDemand": "2024-01-28T11:03:25+01:00", "startTime": "2024-01-28T11:24:49+01:00", "endTime": "2024-01-28T11:25:09+01:00", "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "ZipFile", "slug": "create-zip-file-online", "jsonRequestSample": null, "jsonResponseSample": null, "specificDeveloperRequestDocumentation": null, "specificDeveloperResponseDocumentation": null, "longDescription": null }, "user": [], "accomplished": true, "userIsNotifiedByEmail": "off", "userIsNotifiedByPostQuery": "off", "actionResults": [ [ "35084b44a841ec597be3048df44145e8.txt.log" ] ], "priceInTokensAtTimeOfUse": 3, "retryCount": 0, "executionPlannedAt": null, "trackingUrl": "" }

The most important field in this Json is: actionResults, and therefore to download the result: curl --location 'http://mxprocess.com/api/actions/download-action-result/643/35084b44a841ec597be3048df44145e8.txt.log' \ --header 'Authorization: Bearer YOUR_TOKEN' \ --data ''
The format of the download URL is always as follows :
http://mxprocess.com/api/actions/download-action-result/{id}/{fileName}
For example, in our case : id = 643 and fileName = 35084b44a841ec597be3048df44145e8.txt.log

This documentation is not clear? (Python, PHP, Java, JavaScript...) Need help ?

This API is also available in synchronous mode : Developer API : ZipFile