यह API उपयोग में आसान है। आपको बस इन चरणों का पालन करना है

• निःशुल्क खाता बनाएँ
• अपना पता पक्का करने के लिए ईमेल में मिले लिंक पर क्लिक करें।
• क्रेडेंशियल के साथ टोकन बनाएँ

इस CURL कॉल के लिए आप कोई भी भाषा उपयोग कर सकते हैं। (Python, PHP, Java, JavaScript...) मदद चाहिए?

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

यदि आपके क्रेडेंशियल सही हैं, तो हमारा सर्वर उत्तर में एक टोकन देगा: {"token": "YOUR_TOKEN","refresh_token": "YOUR_REFRESH_TOKEN"}
YOUR_TOKEN एक घंटे के लिए मान्य है; YOUR_REFRESH_TOKEN से इसकी अवधि बढ़ाई जा सकती है।


• प्रक्रिया को एसिंक्रोनस रूप से शुरू करने के लिए टोकन का उपयोग करें

कार्रवाई के पैरामीटर

parameters को JSON ऑब्जेक्ट के रूप में भेजें। आवश्यक फ़ील्ड पर आवश्यक.

• width — integer; न्यूनतम 1.
• merge — boolean.
curl --location 'https://mxprocess.com/api/files/start-process' \ --header 'Authorization: Bearer YOUR_TOKEN' \ --form 'file=@"/path_to_file/image.jpg"' \ --form 'actionName="JpgToPdf"' \ --form 'parameters="[[\"width\", [\"600\"]],[\"merge\", [\"0\"]]]"' \ --form 'fileUrl=""' \ --form 'fileContent=""' \ --form 'async="true"'
width पैरामीटर बदलने के लिए 600 की जगह अपनी इच्छित चौड़ाई लिखें।
यदि फ़ाइल URL से उपलब्ध है, तो « file=@.. » फ़ील्ड छोड़कर उसकी URL सीधे « fileUrl » फ़ील्ड में दें।

API प्रक्रिया शुरू होने की पुष्टि के लिए JSON उत्तर भेजता है। “trackingUrl” फ़ील्ड नोट करें, जिससे शुरू की गई प्रक्रिया को ट्रैक किया जा सकता है। उत्तर में प्रक्रिया ID भी है; इस उदाहरण में ID 643 है: { "id": 643, "actionParameters": [], "dateOfDemand": "2024-01-28T11:03:25+01:00", "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "JpgToPdf", "slug": "convert-jpg-image-to-pdf-document", "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" }


• प्रगति देखने के लिए एक सरल GET अनुरोध करें (यह HTTP कॉल हर 10 सेकंड में कर सकते हैं):
curl --location 'https://mxprocess.com/api/actions/get-action-infos/643' \ --header 'Authorization: Bearer YOUR_TOKEN' }}

यदि प्रक्रिया अभी पूरी नहीं हुई है, तो आपको इस प्रकार का उत्तर मिलेगा जिसमें "accomplished": false { "id": 643, "actionParameters": [], "dateOfDemand": "2024-01-28T11:03:25+01:00", "startTime": null, "endTime": null, "hostedFileIds": [ { "fileId": 608, "parameters": "" } ], "action": { "actionName": "JpgToPdf", "slug": "convert-jpg-image-to-pdf-document", "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": "" }

यदि प्रक्रिया पूरी हो गई है, तो आपको इस प्रकार का उत्तर मिलेगा जिसमें "accomplished": true. actionResultsDownloadURLs फ़ील्ड में बनाए गए परिणाम डाउनलोड करने के लिए प्रमाणित URL होते हैं: { "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": "JpgToPdf", "slug": "convert-jpg-image-to-pdf-document", "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": "" }

संबंधित परिणाम डाउनलोड करने के लिए actionResultsDownloadURLs में दिए गए प्रत्येक URL का सीधे उपयोग करें।

क्या यह दस्तावेज़ स्पष्ट नहीं है? (Python, PHP, Java, JavaScript...) मदद चाहिए?

संपर्क करें यह API सिंक्रोनस मोड में भी उपलब्ध है: डेवलपर API : JpgToPdf