{ "uuid": "686600ca-a87a-47b1-8fb9-802132b4aa5d", "lastMigration": 29, "name": "API docs | logoraisr.com", "endpointPrefix": "rest-v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "caab6e17-a3ff-4ae1-ad62-957657b7b884", "documentation": "Get preview image of uploaded file", "method": "get", "endpoint": "previews/:file_id/", "responses": [ { "uuid": "beafbabc-7308-4bed-b14f-039e68679a0a", "body": "{\n \"preview_img_url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "144add51-bab9-42b1-9ba8-0629f40785c4", "body": "", "latency": 0, "statusCode": 400, "label": "BAD REQUEST", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ae62fe21-15d9-4ec5-aedd-c9014209b67d", "body": "", "latency": 0, "statusCode": 403, "label": "FORBIDDEN", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8bc25232-2881-4e89-bd2b-7b3175be15fe", "documentation": "Get process list.", "method": "get", "endpoint": "processes/", "responses": [ { "uuid": "8502b44f-5389-4b24-b969-dbcad85b5c17", "body": "{\n \"crop\": \"\",\n \"flip\": {{faker 'datatype.boolean'}},\n \"mirror\": {{faker 'datatype.boolean'}},\n \"processing_algorithm\": \"\",\n \"resize\": \"\",\n \"rotate\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "34ea0534-0b65-4065-8376-8689664abaa9", "documentation": "Get user project list.", "method": "get", "endpoint": "projects/", "responses": [ { "uuid": "1bd5d6d5-c362-411d-9cdc-0913b4146ea9", "body": "{\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"file_id\": \"{{faker 'string.uuid'}}\",\n \"id\": {{faker 'number.int' max=99999}},\n \"paypal_payment_id\": \"\",\n \"process\": {\n \"crop\": \"\",\n \"flip\": {{faker 'datatype.boolean'}},\n \"mirror\": {{faker 'datatype.boolean'}},\n \"processing_algorithm\": \"\",\n \"resize\": \"\",\n \"rotate\": {{faker 'number.int' max=99999}}\n },\n \"process_id\": \"\",\n \"project_number\": {{faker 'number.int' max=99999}},\n \"project_title\": \"\",\n \"result_file_id\": \"{{faker 'string.uuid'}}\"\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1f6970ba-d190-4e63-a1bb-a70f4703754f", "body": "", "latency": 0, "statusCode": 403, "label": "FORBIDDEN", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7d5be1f0-faa4-44cf-8def-e24f64469a9e", "body": "", "latency": 0, "statusCode": 404, "label": "NOT FOUND", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7e51054e-b458-4859-8120-7a7f1641c3d2", "documentation": "Create a new project.", "method": "post", "endpoint": "projects/", "responses": [ { "uuid": "dabe345e-0ea2-4ab2-9207-6b8799540297", "body": "{\n \"project_id\": {{faker 'number.int' max=99999}},\n \"project_number\": {{faker 'number.int' max=99999}},\n \"result_file_id\": \"{{faker 'string.uuid'}}\"\n}", "latency": 0, "statusCode": 201, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "59a28090-469d-4666-9896-d46fd01cb7c8", "body": "", "latency": 0, "statusCode": 400, "label": "BAD REQUEST", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f4c6b688-460f-4486-bd97-00b8dd471138", "body": "", "latency": 0, "statusCode": 403, "label": "FORBIDDEN", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d4fb8709-468f-4b8e-ab70-dec53c0d5901", "body": "", "latency": 0, "statusCode": 404, "label": "NOT FOUND", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c796ce4e-97bd-41c6-8838-0f4b8ad72169", "documentation": "Get project details.", "method": "get", "endpoint": "projects/:project_number/", "responses": [ { "uuid": "1547a840-aba8-43c5-a8d4-4c089b169131", "body": "{\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"file_id\": \"{{faker 'string.uuid'}}\",\n \"id\": {{faker 'number.int' max=99999}},\n \"paypal_payment_id\": \"\",\n \"process\": {\n \"crop\": \"\",\n \"flip\": {{faker 'datatype.boolean'}},\n \"mirror\": {{faker 'datatype.boolean'}},\n \"processing_algorithm\": \"\",\n \"resize\": \"\",\n \"rotate\": {{faker 'number.int' max=99999}}\n },\n \"process_id\": \"\",\n \"project_number\": {{faker 'number.int' max=99999}},\n \"project_title\": \"\",\n \"result_file_id\": \"{{faker 'string.uuid'}}\"\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fccfa057-266d-4318-9b3e-e6ad3b02370f", "body": "", "latency": 0, "statusCode": 403, "label": "FORBIDDEN", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "226193ca-337e-49a5-95d4-545327906549", "body": "", "latency": 0, "statusCode": 404, "label": "NOT FOUND", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8e9cdb77-340e-4de5-b1b3-a9899bc7eb2c", "documentation": "Get user report list.", "method": "get", "endpoint": "reports/", "responses": [ { "uuid": "80a71496-765c-4596-be71-69876c710de6", "body": "{\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"file_id\": \"{{faker 'string.uuid'}}\",\n \"process_id\": {{faker 'number.int' max=99999}},\n \"report_number\": {{faker 'number.int' max=99999}},\n \"result\": {\n \"colors\": [\n {\n \"blue\": {{faker 'number.int' max=99999}},\n \"green\": {{faker 'number.int' max=99999}},\n \"hex\": \"\",\n \"number_of_pixel\": {{faker 'number.int' max=99999}},\n \"percentage\": \"\",\n \"red\": {{faker 'number.int' max=99999}}\n }\n ],\n \"height\": {{faker 'number.int' max=99999}},\n \"number_of_pixel_in_image\": {{faker 'number.int' max=99999}},\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"result_id\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "440054cd-8f36-4e3c-b9fa-6ba6262ff61a", "body": "", "latency": 0, "statusCode": 403, "label": "FORBIDDEN", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "87aece37-9dea-40f5-964a-1a2641525c46", "body": "", "latency": 0, "statusCode": 404, "label": "NOT FOUND", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2d2ef4fa-574c-44e1-9da1-e4f89868977f", "documentation": "Create a new report.", "method": "post", "endpoint": "reports/", "responses": [ { "uuid": "fd557f9a-b51d-41f7-9baa-050dff10eb74", "body": "{\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"file_id\": \"\",\n \"processing_algorithm\": \"\",\n \"report_number\": {{faker 'number.int' max=99999}},\n \"result\": {\n \"colors\": [\n {\n \"blue\": {{faker 'number.int' max=99999}},\n \"green\": {{faker 'number.int' max=99999}},\n \"hex\": \"\",\n \"number_of_pixel\": {{faker 'number.int' max=99999}},\n \"percentage\": \"\",\n \"red\": {{faker 'number.int' max=99999}}\n }\n ],\n \"height\": {{faker 'number.int' max=99999}},\n \"number_of_pixel_in_image\": {{faker 'number.int' max=99999}},\n \"width\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 201, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4e7e2649-03ed-4728-9015-6525e7e719fc", "body": "", "latency": 0, "statusCode": 400, "label": "BAD REQUEST", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1dfde791-b5c9-4023-9b7f-800c54145c0a", "body": "", "latency": 0, "statusCode": 401, "label": "UNAUTHORIZED", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5f05ad2b-d5bd-4a0c-b1e3-f50f78f79f02", "body": "", "latency": 0, "statusCode": 403, "label": "FORBIDDEN", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9d9ee210-1d5b-4771-9cf5-4402542ca492", "documentation": "Get report details.", "method": "get", "endpoint": "reports/:report_number/", "responses": [ { "uuid": "a44e0369-a5d3-48bc-b08d-4bae48ece3ef", "body": "{\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"file_id\": \"{{faker 'string.uuid'}}\",\n \"process_id\": {{faker 'number.int' max=99999}},\n \"report_number\": {{faker 'number.int' max=99999}},\n \"result\": {\n \"colors\": [\n {\n \"blue\": {{faker 'number.int' max=99999}},\n \"green\": {{faker 'number.int' max=99999}},\n \"hex\": \"\",\n \"number_of_pixel\": {{faker 'number.int' max=99999}},\n \"percentage\": \"\",\n \"red\": {{faker 'number.int' max=99999}}\n }\n ],\n \"height\": {{faker 'number.int' max=99999}},\n \"number_of_pixel_in_image\": {{faker 'number.int' max=99999}},\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"result_id\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "aa5e910b-39ef-49ec-bc79-9c335e10ac00", "body": "", "latency": 0, "statusCode": 403, "label": "FORBIDDEN", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a225ef01-f832-4a19-8697-85309f7785a9", "body": "", "latency": 0, "statusCode": 404, "label": "NOT FOUND", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6e684787-03da-4fa2-99c1-77c3841cb182", "documentation": "Get the result from image processing", "method": "get", "endpoint": "results/:result_file_id/", "responses": [ { "uuid": "49b7a848-9548-4645-a4ff-e92e339f8c2c", "body": "{\n \"result_file_url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8a665624-cc2f-41fc-af1f-7a0f5bd2044a", "body": "", "latency": 0, "statusCode": 400, "label": "BAD REQUEST", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "afdb7020-d53d-44ea-977d-318d483f3b4a", "body": "", "latency": 0, "statusCode": 403, "label": "FORBIDDEN", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a7d643ca-ca41-4908-ab40-b6949569350c", "documentation": "Upload a new image", "method": "post", "endpoint": "uploads/", "responses": [ { "uuid": "333c5bc7-281b-402c-9403-286c1212a76b", "body": "{\n \"file_id\": \"{{faker 'string.uuid'}}\"\n}", "latency": 0, "statusCode": 201, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2000ba7a-9f6b-4aa2-94b0-44ede475c967", "body": "", "latency": 0, "statusCode": 400, "label": "BAD REQUEST", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "caab6e17-a3ff-4ae1-ad62-957657b7b884" }, { "type": "route", "uuid": "8bc25232-2881-4e89-bd2b-7b3175be15fe" }, { "type": "route", "uuid": "34ea0534-0b65-4065-8376-8689664abaa9" }, { "type": "route", "uuid": "7e51054e-b458-4859-8120-7a7f1641c3d2" }, { "type": "route", "uuid": "c796ce4e-97bd-41c6-8838-0f4b8ad72169" }, { "type": "route", "uuid": "8e9cdb77-340e-4de5-b1b3-a9899bc7eb2c" }, { "type": "route", "uuid": "2d2ef4fa-574c-44e1-9da1-e4f89868977f" }, { "type": "route", "uuid": "9d9ee210-1d5b-4771-9cf5-4402542ca492" }, { "type": "route", "uuid": "6e684787-03da-4fa2-99c1-77c3841cb182" }, { "type": "route", "uuid": "a7d643ca-ca41-4908-ab40-b6949569350c" } ] }