MXPROCESS API documentation | REST API integration

Documentation

Get started with the API

This API is simple to use. Follow these steps to authenticate, upload a file and receive your result.

Create an accountCreate a free account

Confirm your emailClick on the link you receive by email to confirm your address.

Generate a tokenUse your credentials to authenticate API requests.

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

curl --location --request POST 'https://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.

Upload a fileUse the token to upload the file on our server.

Refresh your tokenA refresh token gets a new access token without asking the user to log in again.

Manage notificationsAfter registration, customize notifications using the Settings button.

curl --location --request POST 'https://mxprocess.com/api/files/upload' \
                                        --header 'Authorization: Bearer YOUR_TOKEN' \
                                        --form 'file=@"file.pdf"' \
                                        --form 'description="My awesome file"'

curl --location --request POST 'https://mxprocess.com/api/files/upload' \
                                        --header 'Authorization: Bearer YOUR_TOKEN' \
                                        --form 'file=@"file.pdf"' \
                                        --form 'description="My awesome file"'

You can find more details in this section