--- title: "Preflight Web API" canonical: https://customerscanvas.com/docs/cc6/preflight-webapi.htm archived: true applies_to: - product: "Customer's Canvas On-Premises" - product: "Preflight Tool" versions: ["1.15.3", "1.8.4-1.23.8 (may differ)"] --- **You’re viewing outdated documentation.** [View the latest Customer’s Canvas On-Premises documentation](https://customerscanvas.com/docs/on-premises/). # Preflight Web API **Applies to:** Customer's Canvas On-Premises; Preflight Tool 1.15.3, 1.8.4-1.23.8 (may differ) · **Archived documentation** The Preflight Web API is a REST API that allows you to verify that users' print files are compatible with your printing equipment. You can [define preflight rules](https://customerscanvas.com/docs/cc6/preflight-tool-rules.htm.md) and check if print files match those rules by using HTTP requests. The Preflight Web API allows you to: - Upload files to the server - Download files from the server - Check preflight rules - Get the build info After you have deployed the Preflight Tool, you can navigate to `/swagger` and explore the interactive Web API in your browser. You can also [download](https://customerscanvas.com/docs/cc6/samples/PreflightWebApi.zip) a code sample demonstrating how to validate print files. This Web API doesn't require authentication. In the following examples, we use the **appUrl** variable that represents a folder on your server where you deployed this tool, for example, `http://example.com/pt/`. ## Uploading a File to the Server To validate that print files are compatible with your printing equipment, you must first upload them to your server. This endpoint allows for uploading a print file. #### Request type [POST] #### URL ``` ~/api/files/upload ``` #### Example call You can pass and upload a file as follows: ``` ... const upload = async (event) => { const file = event.target.files[0]; const formData = new FormData(); formData.append('file', file); const response = await fetch(appUrl + "api/files/upload?dpi=200", { method: "POST", body: formData }); console.log(await response.json()); } ``` #### Success response As a result, you get the GUID that your print file obtained after saving it on the server. ``` Status Code: 200 OK Content: [ "425a3537-2e59-450d-bbc2-484fcd3d63bd.pdf" ] ``` ## Getting a File from the Server To download a file from the server, you can get a file stream by the file's GUID. #### Request type [GET] #### URL ``` ~/api/files/get/{GUID} ``` #### Required URL Param **GUID** - a file identifier with an extension. #### Example call ```html ``` In the following section, you can learn how to use this endpoint to perform the preflight check. #### Success response If the result is successful, this method returns the content of the file in a file stream. ``` Status Code: 200 OK Content-type: application/octet-stream ``` ## Checking the Preflight Rules You can pass an array of preflight rules and a URL that link to a print file to check whether this file matches the rules. In the current implementation, you can check the following rules through this Web API: - ["colorspace"](https://customerscanvas.com/docs/cc6/preflight-tool-rules.htm.md) - ["spotcolors"](https://customerscanvas.com/docs/cc6/preflight-tool-rules.htm.md) - ["resolution"](https://customerscanvas.com/docs/cc6/preflight-tool-rules.htm.md) - ["sameorientation"](https://customerscanvas.com/docs/cc6/preflight-tool-rules.htm.md) - ["forbiddenfonts"](https://customerscanvas.com/docs/cc6/preflight-tool-rules.htm.md) - ["allowedfonts"](https://customerscanvas.com/docs/cc6/preflight-tool-rules.htm.md) - ["fonttypes"](https://customerscanvas.com/docs/cc6/preflight-tool-rules.htm.md) - ["minfontsize"](https://customerscanvas.com/docs/cc6/preflight-tool-rules.htm.md) - ["textascurves"](https://customerscanvas.com/docs/cc6/preflight-tool-rules.htm.md) - ["embeddedfonts"](https://customerscanvas.com/docs/cc6/preflight-tool-rules.htm.md) #### Request type [POST] #### URL ``` "~/api/rules/check" ``` #### Request Payload To validate your print file, you can pass its name, resolution, and required rules in the request body in the following format. ``` { "file": "http://example.com/pt/api/files/get/425a3537-2e59-450d-bbc2-484fcd3d63bd.pdf", "dpi": 200, "rules": [ { "type": "embeddedfonts" } ] } ``` #### Example call ``` // The link to the print file. const file = appUrl + "api/files/get/425a3537-2e59-450d-bbc2-484fcd3d63bd.pdf"; // Resolution of the print file. const dpi = 300; // The required color space and page orientation. const rules = [ { "type": "colorspace", "params": { "allowedColorSpaces": ["cmyk"] } }, { "type": "sameorientation" } ]; // Check the file. const check = async () => { const response = await fetch(appUrl + "api/rules/check", { method: "post", body: JSON.stringify({ dpi, file, rules }), headers: { 'Content-Type': 'application/json' } }); const result = await response.json(); // Output the resulting array, where each element is an array of preflight results for a page. console.log(result); } ``` #### Success response This endpoint returns an array, where each element corresponds to a page in the print file. These elements contain validation results. The result of validation of a one-page PDF file may look as follows: ``` Status Code: 200 OK Content: [ [ { name: "colorspace", result: false, expected: ["cmyk"], actual: ["rgb"] }, { name: "sameorientation", result: true, expected: ["horizontal"], actual: [] } ] ] ``` ## Getting the Build Info You can get the version, build date, build configuration, and application name by using this endpoint. You may need these details when contacting our support team. #### Request type [GET, HEAD] #### URL ``` ~/api/info ``` #### Example call ``` const info = async () => { const response = await fetch(appUrl + "api/info"); console.log(await response.json()); }; ``` #### Success response ``` Status Code: 200 OK Content: { version: "1.7.2", buildDate: "9/9/2020", configuration: "Release", appName: "Preflight" } ``` ## See Also ### Manual - [Preflight Rules](https://customerscanvas.com/docs/cc6/preflight-tool-rules.htm.md) - [Uploading Files through the Web API](https://customerscanvas.com/docs/cc6/preflight-tool-faq.htm.md) ### Downloads - [Code sample](https://customerscanvas.com/docs/cc6/samples/PreflightWebApi.zip)