{ "uuid": "5cac8d96-7415-4d5c-9c05-bd3cd9130500", "lastMigration": 29, "name": "Api Documentation", "endpointPrefix": "apiv1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "60b24e1b-7e04-4604-8d55-edb8d884fb30", "documentation": "forgotPassword", "method": "post", "endpoint": "authentication/forgotPassword", "responses": [ { "uuid": "2116de1c-e016-4e6a-9b7c-30cf1967a9f5", "body": "{\n \"code\": \"{{oneOf (array 'success' 'failure')}}\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "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": "f0ccc770-bd87-4e5b-988e-f01fee0315c0", "body": "", "latency": 0, "statusCode": 201, "label": "Created", "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": "adfac442-e0ca-4a51-87f7-710985cd9852", "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "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": "78371848-7461-4225-b03c-a5a3b6a13893", "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": "e544110e-0ccc-46de-a1ae-e9054a5425b2", "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": "d1b30ce5-36d0-4769-926f-2b41d15469ef", "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": "dbd62e16-d8d1-48c8-b9f5-d47ea9f0606d", "documentation": "register", "method": "post", "endpoint": "authentication/register", "responses": [ { "uuid": "36320de0-9de7-4a5c-967c-31435cb092a4", "body": "{\n \"code\": \"{{oneOf (array 'success' 'failure')}}\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "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": "cc7ba167-2eb7-427d-9bc4-4d84337f278f", "body": "", "latency": 0, "statusCode": 201, "label": "Created", "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": "ed506b94-17ed-4c96-a4d0-e4c41c4c0f3d", "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "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": "7a6cfcc4-9a4f-4c99-85b4-4483ac366e45", "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": "f33dc7c8-7666-4f74-ae10-37a382fa7e4d", "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": "0637f86b-ff12-4d2b-a840-182fc35dda44", "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": "86df68f5-ba46-4460-a1fc-ecb2432f1beb", "documentation": "validates the mail token and set new password", "method": "post", "endpoint": "authentication/setForgotPassword", "responses": [ { "uuid": "acb2028f-fc0f-4f63-8f6e-99d3cafaee69", "body": "{\n \"code\": \"{{oneOf (array 'success' 'failure')}}\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "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": "2c0faa28-d75a-4119-80a3-9f97e597c5e5", "body": "", "latency": 0, "statusCode": 201, "label": "Created", "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": "00b41285-dbb1-4d14-bfb6-de041d50905e", "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "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": "bd80d062-cecf-43a6-ad4f-b626cfb14407", "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": "5bee6d6a-9e91-4750-b127-479ac3dfe4aa", "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": "f9f3c563-1509-4055-97eb-6c5aa34c458b", "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": "635c480e-2b4a-4f94-86c1-78846e25e77f", "documentation": "authenticate the user and returns the token", "method": "post", "endpoint": "authentication/token", "responses": [ { "uuid": "a98a2b1c-f814-48d1-bba2-213ba9b99358", "body": "{\n \"activities\": \"\",\n \"customerId\": {{faker 'number.int' max=99999}},\n \"email\": \"\",\n \"fullName\": \"\",\n \"partnerId\": {{faker 'number.int' max=99999}},\n \"role\": \"\",\n \"settings\": \"\",\n \"token\": \"\",\n \"type\": \"\",\n \"userId\": {{faker 'number.int' max=99999}},\n \"username\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "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": "f4263b7f-5e55-4158-92f0-264523083369", "body": "", "latency": 0, "statusCode": 201, "label": "Created", "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": "8084f4ae-8a24-4722-bf16-4ee8fee82cb3", "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "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": "e0986ec0-91b5-46f7-b02b-dbac0b3fae8b", "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": "83039235-d88f-4a0e-adf8-f239544cce3c", "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": "fb131422-d9e9-4cea-9735-6a98bb346cfe", "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": "d28e52fe-5db8-4654-a716-4cab8b02854f", "documentation": "validates the mail token", "method": "post", "endpoint": "authentication/validateMailToken", "responses": [ { "uuid": "034d632a-4da1-4cdc-aa83-67fe6af1141c", "body": "{\n \"code\": \"{{oneOf (array 'success' 'failure')}}\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "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": "fcb123ae-f074-40b6-8db7-645e5a43b0e8", "body": "", "latency": 0, "statusCode": 201, "label": "Created", "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": "eb08ba90-a664-404d-82d1-c1a76ef51463", "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Unexpected error", "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": "70fc1187-dcca-498a-b00d-016978ea2bd7", "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": "5cf1f55f-c222-4eb2-9473-66e01509a471", "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": "b98ac99d-0908-4e97-bb07-b1d4230de275", "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" } ], "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": "60b24e1b-7e04-4604-8d55-edb8d884fb30" }, { "type": "route", "uuid": "dbd62e16-d8d1-48c8-b9f5-d47ea9f0606d" }, { "type": "route", "uuid": "86df68f5-ba46-4460-a1fc-ecb2432f1beb" }, { "type": "route", "uuid": "635c480e-2b4a-4f94-86c1-78846e25e77f" }, { "type": "route", "uuid": "d28e52fe-5db8-4654-a716-4cab8b02854f" } ] }