krzychna33 / que-crm2-api

QueCRM | rest api [Node.js, Express, MongoDB]

QueCRM2 RestAPI

SETUP

Environment: Mongodb, nodejs

1. set up your .env file
2. Install dependencies
3. start app by lauching server.js file

Routes

for authentication please add a header to request: x-auth - value for this header you can get from POST /api/v1/users/login

Route for uploaded files: /uploaded-files/{file name from /storage/uploaded}

1. Authentication

POST /api/v1/users/login

{
          "email": "[e-mail]",
          "password": "admin123"
}

POST /api/v1/users/

{
    "email": "[e-mail]",
    "password": "admin123"
}

GET /api/v1/users/me

DELETE /api/v1/users/logout

2. Clients

GET /api/v1/clients/5b4e01933991180708501704

GET /api/v1/clients/

POST /api/v1/clients/

{
    "firstName": "KRzysiek",
    "lastName": "Admin",
    "email": "[e-mail]"
}

PUT /api/v1/clients/5b4e01933991180708501704

{
    "firstName": "KRzysiek",
    "lastName": "Admin",
    "email": "[e-mail]"
}

DELETE /api/v1/clients/5b4e01933991180708501704

3. Questionnaries

POST /api/v1/questionnaires

{
    "clientId": "5b4f0efc5ba7833918c93d4d",
    "styles": {
        
    },
    "data": {
        
    },
    "formFields": [{
        "HTMLLabel": "What is your name?",
        "HTMLInputType": "text",
        "HTMLName": "clientName"
    }]
}

GET /api/v1/questionnaires

GET /api/v1/questionnaires/5b505beb82ade41ab4ae0170

PUT /api/v1/questionnaires/5b52aa810bf5cf2f548e334d

    {
    "clientId": "5b50673b4cd7c82d74af6a11",
    "styles": {
        
    },
    "data": {
        
    },
    "formFields": [{
        "position": 1,
        "HTMLLabel": "What is your dsds?",
        "HTMLInputType": "text",
        "HTMLName": "clientName"
    },
    {
        "position": 3,
        "HTMLLabel": "Are you student?",
        "HTMLInputType": "radio",
        "HTMLName": "studnetStatus",
        "HTMLValue": "yes",
        "HTMLDescription": "yes"
    },
    {
        "position": 4,
        "HTMLLabel": "Are you student?",
        "HTMLInputType": "radio",
        "HTMLName": "studnetStatus",
        "HTMLValue": "no",
        "HTMLDescription": "no"
    },
    {
        "position": 5,
        "HTMLLabel": "What do you use?",
        "HTMLInputType": "checkbox",
        "HTMLName": "socials",
        "HTMLValue": "facebook",
        "HTMLDescription": "Facebook"
    },
    {
        "position": 6,
        "HTMLLabel": "What do you use?",
        "HTMLInputType": "checkbox",
        "HTMLName": "socials",
        "HTMLValue": "twitter",
        "HTMLDescription": "Twitter"
    },
    {
        "position": 7,
        "HTMLLabel": "When were you born?",
        "HTMLInputType": "date",
        "HTMLName": "brith"
    },
    {
        "position": 8,
        "HTMLLabel": "Your photo",
        "HTMLInputType": "file",
        "HTMLName": "photo"
    }
    ],
    "selects": [
        {
            "position": 2,
            "HTMLLabel": "Choose your favourite car",
            "HTMLName": "cars",
            "options": [
                {
                    "HTMLValue": "volvo",
                    "HTMLDescription": "Volvo"
                },
                {
                    "HTMLValue": "bmw",
                    "HTMLDescription": "BMW"
                },
                {
                    "HTMLValue": "audi",
                    "HTMLDescription": "Audi"
                }
            ]
        }
    ]
}

DELETE /api/v1/questionnaires/5b51aa810bf5cf2f548e334d

GET /api/v1/questionnaires/get-results/5b51d66397f4a40f5cbc0585

4. Templates

POST /api/v1/templates

{
"name": "Default Template",
"styles": {
    "backgroundColor": "#DFEFFD",
    "headerColor": "#0F1011",
    "headerSize": 28,
    "textColor": "#2D3033",
    "textSize": 18,
    "buttonsColor": "3433CF"
    }
}

GET /api/v1/templates

GET /api/v1/templates/5b53330ec7474625b48ab6a1

PUT /api/v1/templates/5b53330ec7474625b48ab6a1

{
    "name": "A new name!e",
    "styles": {
        "backgroundColor": "#DFEFFD",
        "headerColor": "#0F1011",
        "headerSize": 28,
        "textColor": "#2D3033",
        "textSize": 18,
        "buttonsColor": "3433CF"
    }
}

DELETE /api/v1/templates/5b53330ec7474625b48ab6a1