Cette API est simple à utiliser. Il vous suffit de suivre ces étapes

• Créer un compte gratuitement
• Cliquez sur le lien reçu par e-mail pour confirmer votre adresse.
• Générer un jeton avec vos identifiants

Vous pouvez utiliser n’importe quel langage pour effectuer cet appel CURL. (Python, PHP, Java, JavaScript...) Besoin d’aide ?

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

Si vos identifiants sont corrects, notre serveur vous fournira un jeton en réponse : {"token": "YOUR_TOKEN","refresh_token": "YOUR_REFRESH_TOKEN"}
YOUR_TOKEN est valide pendant une heure ; sa durée peut être prolongée avec YOUR_REFRESH_TOKEN.


• Utilisez le jeton pour démarrer le traitement de façon asynchrone
Téléchargement des résultats : Lorsqu’il est présent dans une réponse API, actionResultsDownloadURLs contient les URL authentifiées permettant de télécharger chaque fichier de résultat généré.



API asynchrone : inspection universelle de fichier

Envoyez un fichier non vide de 50 MiB maximum. L’original est lu mais jamais déplacé, modifié ou supprimé. Le rapport est diagnostique : le résultat de l’antivirus est un signal de triage préliminaire et l’ensemble de règles inclus ne constitue qu’un point de départ minimal.

Point d’accès: POST https://mxprocess.com/api/files/start-process
Authentification: JWT Bearer
Coût: 12 jetons, facturés après réussite.

Démarrez une inspection

curl --location --request POST 'https://mxprocess.com/api/files/start-process' \ --header 'Authorization: Bearer YOUR_TOKEN' \ --form 'actionName=FileInspection' \ --form 'file=@/path/to/file.bin' \ --form 'parameters=[]' \ --form 'async=true'

Enregistrez le id et interrogez /api/actions/get-action-infos/{id} avec le même JWT. Une fois terminé, actionResults contient un fichier authentifié téléchargeable *.inspection.json .

Réponse initiale

{"id":123,"action":{"actionName":"FileInspection","slug":"inspect-file-online"},"accomplished":false,"actionResults":[],"trackingUrl":"https://mxprocess.com/api/actions/get-action-infos/123"}

Exemple de réponse réussie

{ "fileName": "photo.jpg", "sizeBytes": 24576, "sha256": "...", "mimeDetected": "image/jpeg", "mimeDeclared": null, "antivirusSignal": {"status": "clean", "detail": "preliminary triage signal"}, "exif": {"ImageWidth": 800, "ImageHeight": 600}, "mediaProbe": null, "detectionRules": {"status": "clean", "matches": [], "ruleset": "minimal detection rule set"}, "ocrText": "Complete text detected in the image...", "generatedAt": "2026-09-12T12:00:00+00:00" }

Si un outil local facultatif est indisponible, sa section est renvoyée comme not_run ou null. Une cardinalité invalide, un fichier inaccessible ou un fichier de plus de 50 MiB est rejeté avant l’analyse.

Nous contacter


L’API renvoie une réponse JSON confirmant le démarrage du traitement. Notez le champ « trackingUrl », qui permet de suivre le traitement lancé. La réponse contient aussi son identifiant ; dans cet exemple, il s’agit de 643 : { "id": 643, "actionParameters": [], "dateOfDemand": "2024-01-28T11:03:25+01:00", "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "FileInspection", "slug": "inspect-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": "https://mxprocess.com/api/actions/get-action-infos/643" }


• Pour suivre l’avancement, effectuez une simple requête GET (vous pouvez appeler cette URL toutes les 10 secondes) :
curl --location 'https://mxprocess.com/api/actions/get-action-infos/643' \ --header 'Authorization: Bearer YOUR_TOKEN' }}

Si le traitement n’est pas terminé, vous recevrez ce type de réponse avec "accomplished": false { "id": 643, "actionParameters": [], "dateOfDemand": "2024-01-28T11:03:25+01:00", "startTime": null, "endTime": null, "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "FileInspection", "slug": "inspect-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": "" }

Une fois le traitement terminé, vous recevrez ce type de réponse avec "accomplished": true. Le champ actionResultsDownloadURLs contient les URL authentifiées permettant de télécharger les résultats générés : { "actionResultsDownloadURLs": [ "https://mxprocess.com/api/actions/download-result/643/35084b44a841ec597be3048df44145e8.txt.log/YOUR_TOKEN" ], "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": "FileInspection", "slug": "inspect-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": "" }

Utilisez directement chaque URL fournie dans actionResultsDownloadURLs pour télécharger le résultat correspondant.

Cette documentation n’est pas claire ? (Python, PHP, Java, JavaScript...) Besoin d’aide ?

Nous contacter Cette API est également disponible en mode synchrone : API développeur : FileInspection