api

api
- Run locally
- API reference

Run locally

docker-compose up

Execute a command inside the container

docker-compose run --rm web <your-command>

Available commands

npm start
npm run build
npm run test
npm run lint (npm run lint -- --fix to lint automatically)
npm run format

Introduce code changes

Before pushing your changes, you should:

Lint and format your code:

npm run format
npm run lint -- --fix

Check that the tests still pass:

npm run test:e2e

API reference

⚠️ Warning

All endpoints except authentication endpoints are protected and require authentication.

Authentication endpoints

Register

POST /auth/register

Parameters	Type	In	Description
email	string	body	[required]
password	string	body	[required]
role	string	body	[required]

Request

POST /auth/register
  {
    "email":"[email protected]",
    "password":"12345678",
    "role":"User"
  }

Response

Status: 201 CREATED

{
  "id": 1,
  "uuid": "some-uuid",
  "username": "test",
  "email":"[email protected]"
  "isActive": true,
  "cards": []
}

Login

PUT /auth/login

Parameters	Type	In	Description
email	string	body	[required]
password	string	body	[required]

Request

PUT /auth/login
  {
    "email":"[email protected]"
    "password":"12345678"
  }

Response

Status: 200 OK

{
  "status": 200,
  "token": "some-jwt-token"
}

Users endpoints

Get a user

GET /user/:uuid

Parameters	Type	In	Description
uuid	string	query	[required]

Request

GET /user/some-uuid

Response

Status: 200 OK

{
  "id": 1,
  "username": "test",
  "email": "[email protected]",
  "isActive": true,
  "cards":
  [
    {
      "id": 1,
      "shopId": 1,
      "userId": 1,
      "startAt": "",
      "endAt": "",
      "isActive": true,
      "shop": {
        "companyName": "Bistrot123",
        "activity":"Restauration",
        "siren": "123456789",
        "siret": "12345678901234",
        "email": "[email protected]",
        "zipCode": "12345",
        "lat":"22.366329",
        "long": "-10.137468",
        "phone": "0632547698",
        "address": "12 rue du bistrot",
        "city": "Paris"
      },
      "balances": [
        {
          "id": 1,
          "promotionId": 1,
          "cardId": 1,
          "counter": 0,
          "isActive": true
          "promotion": {
            "id": 1,
            "shopId": 1,
            "name": "Promotion",
            "description": "Promotion description",
            "startAt": "2019-05-27",
            "endAt": "2020-05-27",
            "checkoutLimit": 10,
          }
        }
      ]
    },
    {
      "id": 2,
      "shopId": 2,
      "userId": 1,
      "startAt": "",
      "endAt": "",
      "isActive": true,
      "shop": {
        "companyName": "Coffee Shop",
        "activity":"Restauration",
        "siren": "987654321",
        "siret": "98765432101234",
        "email": "[email protected]",
        "zipCode": "54321",
        "lat": "18.365229",
        "long": "-11.147119",
        "phone": "0698765432",
        "address": "1 rue du café",
        "city": "Paris"
      },
      "balances": [
        {
          "id": 2,
          "promotionId": 2,
          "cardId": 2,
          "counter": 5,
          "isActive": true
          "promotion": {
            "id": 2,
            "shopId": 2,
            "name": "Promotion2",
            "description": "Promotion2 description",
            "startAt": "2019-05-27",
            "endAt": "2020-05-27",
            "checkoutLimit": 20,
          }
        }
      ]
    }
  ]
}

Get user's cards

GET /user/cards

Request

GET /user/cards

Response

Status: 200 OK

[
  {
    "id": 1,
    "shopId": 1,
    "userId": 1
  },
  {
    "id": 2,
    "shopId": 2,
    "userId": 1
  },
  {
    "id": 3,
    "shopId": 3,
    "userId": 1
  }
]

Update a user

PUT /user/:id

Parameters	Type	In	Description
id	number	query	[required]
username	string	body	[optional]
email	string	body	[optional]
birthday	string	body	[optional]
sexe	string	body	[optional]

Request

PUT /user/1
  {
    "username": "test",
    "email":"[email protected]"
  }

Response

Status: 200 OK

{
  "id": 1,
  "username": "test",
  "email":"[email protected]"
  "isActive": true,
  "cards": []
}

Delete a user

DELETE /user/:id

Parameters	Type	In	Description
id	number	query	[required]

Request

DELETE /user/1

Response

Status: 200 OK

{
  "message": "User deleted"
}

Shops endpoints

Get all shops

GET /shop/

Parameters	Type	In	Description
distance	number	query	[required] Distance in metres
lat	number	query	[required] Latitude
long	number	query	[required] Longitude
isActive	boolean	query	[required] Active

Request

GET /shop/?distance=3000&long=2.3690961&lat=48.8573185

Response

Status: 200 OK

[
  {
    "id": 1,
    "companyName": "Bistrot123",
    "activity":"Restauration",
    "siren": "123456789",
    "siret": "12345678901234",
    "email": "[email protected]",
    "zipCode": "12345",
    "lat": "48.8578461",
    "long": "2.3685758",
    "phone": "0632547698",
    "address": "12 rue du bistrot",
    "city": "Paris"
    "isActive": true,
  }
]

Get a shop

GET /shop/:id

Parameters	Type	In	Description
id	number	query	[required]

Request

GET /shop/1

Response

Status: 200 OK

{
  "id": 1,
  "companyName": "Bistrot123",
  "activity": "Restauration",
  "siren": "123456789",
  "siret": "12345678901234",
  "email": "[email protected]",
  "zipCode": "12345",
  "lat": "22.366329",
  "long": "-10.137468",
  "phone": "0632547698",
  "address": "12 rue du bistrot",
  "city": "Paris",
  "isActive": true
}

Get a shop's promotions

GET /shop/:id/promotion

Parameters	Type	In	Description
id	number	query	[required]

Request

GET /shop/1/promotion

Response

Status: 200 OK

[
  {
    "id": 1,
    "shopId": 1,
    "name": "Promotion",
    "description": "Promotion description",
    "startAt": "2019-05-27",
    "endAt": "2020-05-27",
    "checkoutLimit": 10,
    "isActive": true
  }
]

Get a shop's cards

GET /shop/:id/cards

Parameters	Type	In	Description
id	number	query	[required]

Request

GET /shop/1/cards

Response

Status: 200 OK

[
  {
    "id": 1,
    "url": "https://example.com",
    "isActive": true,
    "shopId": 1,
    "userId": 1,
    "user": {
      "id": 1,
      "username": "test",
      "email": "[email protected]",
      "isActive": true
    },
    "balances": []
  },
  {
    "id": 2,
    "url": "https://example.com",
    "isActive": true,
    "shopId": 1,
    "userId": 2,
    "user": {
      "id": 2,
      "username": "test2",
      "email": "[email protected]",
      "isActive": true
    },
    "balances": []
  }
]

Get a shop's campaigns

GET /shop/:id/campaigns

Parameters	Type	In	Description
id	number	query	[required]

Request

GET /shop/1/campaigns

Response

Status: 200 OK

[
  {
    "id": 1,
    "promotionId": 1,
    "shopId": 1,
    "subject": "Hello",
    "textData": "New promotion available at your store!",
    "isActive": true
  }
]

Create a shop

POST /shop

Parameters	Type	In	Description
companyName	string	body	[required]
activity	string	body	[required]
siren	string	body	[required]
siret	string	body	[required]
email	string	body	[required]
zipCode	string	body	[required]
lat	string	body	[required]
long	string	body	[required]
phone	string	body	[required]
address	string	body	[required]

Request

POST /shop
  {
    "companyName": "Bistrot123",
    "activity":"Restauration",
    "siren": "123456789",
    "siret": "12345678901234",
    "email": "[email protected]",
    "zipCode": "12345",
    "lat":"22.366329",
    "long": "-10.137468",
    "phone": "0632547698",
    "address": "12 rue du bistrot",
  }

Response

Status: 201 CREATED

{
  "message": "Shop created"
}

Update a shop

PUT /shop/:id

Parameters	Type	In	Description
id	number	query	[required]
companyName	string	body	[optional]
activity	string	body	[optional]
siren	string	body	[optional]
siret	string	body	[optional]
email	string	body	[optional]
zipCode	string	body	[optional]
lat	string	body	[optional]
long	string	body	[optional]
phone	string	body	[optional]
address	string	body	[optional]

Request

PUT /shop/1
  {
    "companyName": "Bistrot123",
    "siren": "123456789",
    "siret": "12345678901234",
    "email": "[email protected]",
    "zipCode": "12345",
    "lat":"22.366329",
    "long": "-10.137468",
    "phone": "0632547698",
    "address": "12 rue du bistrot",
  }

Response

Status: 200 OK

{
  "message": "Shop updated"
}

Delete a shop

DELETE /shop/:id

Parameters	Type	In	Description
id	number	query	[required]

Request

DELETE /shop/1

Response

Status: 200 OK

{
  "message": "Shop deleted"
}

Cards endpoints

Get a card

GET /card/:id

Parameters	Type	In	Description
id	number	query	[required]

Request

GET /card/1

Response

Status: 200 OK

{
  "id": 1,
  "shopId": 1,
  "userId": 1
}

Create a card

POST /card

Parameters	Type	In	Description
shopId	number	body	[required]
userId	number	body	[optional] Need to be specified if the card is created by a Fider
isActive	boolean	body	[optional]

Request

POST /card
  {
    "shopId": 1,
  }

Response

Status: 201 CREATED

{
  "message": "Card created"
}

Update a card

PUT /card/:id

Parameters	Type	In	Description
id	number	query	[required]
isActive	boolean	body	[optional]

Request

PUT /card/1
  {
    "isActive": false,
  }

Response

Status: 200 OK

{
  "message": "Card updated"
}

Delete a card

DELETE /card/:id

Parameters	Type	In	Description
id	number	query	[required]

Request

DELETE /card/1

Response

Status: 200 OK

{
  "message": "Card deleted"
}

Promotions endpoints

Get a promotion

GET /promotion/:id

Parameters	Type	In	Description
id	number	query	[required]

Request

GET /promotion/1

Response

Status: 200 OK

{
  "id": 1,
  "shopId": 1,
  "name": "Promotion",
  "description": "Promotion description",
  "startAt": "2019-05-27",
  "endAt": "2020-05-27",
  "checkoutLimit": 10
}

Create a promotion

POST /promotion

Parameters	Type	In	Description
name	string	body	[required]
description	string	body	[optional]
checkoutLimit	number	body	[required]
startAt	string	body	[optional]
endAt	string	body	[required]
isActive	boolean	body	[optional]

Request

POST /promotion
  {
    "name": "Promotion",
    "description": "Promotion description",
    "startAt": "2019-05-27",
    "endAt": "2020-05-27",
    "checkoutLimit": 10,
  }

Response

Status: 201 CREATED

{
  "message": "Promotion created"
}

Update a promotion

PUT /promotion/:id

Parameters	Type	In	Description
id	number	query	[required]
name	string	body	[optional]
description	string	body	[optional]
checkoutLimit	number	body	[optional]
endAt	string	body	[optional]
isActive	boolean	body	[optional]

Request

PUT /promotion/1
  {
    "description": "Promotion description",
    "endAt": "2020-05-27",
  }

Response

Status: 200 OK

{
  "message": "Promotion updated"
}

Delete a promotion

DELETE /promotion/:id

Parameters	Type	In	Description
id	number	query	[required]

Request

DELETE /promotion/1

Response

Status: 200 OK

{
  "message": "Promotion deleted"
}

Balances endpoints

Get a balance

GET /balance/:id

Parameters	Type	In	Description
id	number	query	[required]

Request

GET /balance/1

Response

Status: 200 OK

{
  "id": 1,
  "promotionId": 1,
  "cardId": 1,
  "counter": 0,
  "isActive": true
}

Create a balance

POST /balance

Parameters	Type	In	Description
promotionId	number	body	[required]
cardId	number	body	[required]
counter	number	body	[optional] Default 0
isActive	boolean	body	[optional]

Request

POST /balance
  {
    "promotionId": 1,
    "cardId": 1,
    "counter": 0,
    "isActive": true
  }

Response

Status: 201 CREATED

{
  "message": "Balance created"
}

Update a balance

PUT /balance/:id

Parameters	Type	In	Description
id	number	query	[required]
counter	number	body	[optional]
isActive	boolean	body	[optional]

Request

PUT /balance/1
  {
    "counter": 10,
    "isActive": false
  }

Response

Status: 200 OK

{
  "message": "Balance updated"
}

Delete a balance

DELETE /balance/:id

Parameters	Type	In	Description
id	number	query	[required]

Request

DELETE /balance/1

Response

Status: 200 OK

{
  "message": "Balance deleted"
}

Checkout endpoint

PUT /checkout

Parameters	Type	In	Description
uuid	string	body	[required] uuid of user (scanned from QR code)
promotionId	number	body	[required] promotion id to apply

Request

PUT /checkout
  {
    "promotionId": 1,
    "uuid": some-uuid
  }

Response

Status: 200 OK

{
  "message": "Balance updated" // increments counter +1
}

or

Status: 200 OK

{
  "message": "Promotion limit reached" // Limit is reached, customer gets prize
}

Campaigns endpoints

Get a campaign

GET /campaign/:id

Parameters	Type	In	Description
id	number	query	[required]

Request

GET /campaign/1

Response

Status: 200 OK

{
  "id": 1,
  "promotionId": 1,
  "shopId": 1,
  "subject": "Hello",
  "textData": "New promotion available at your store!",
  "isActive": true
}

Create a campaign

POST /balance

Parameters	Type	In	Description
promotionId	number	body	[optional]
subject	string	body	[required]
textData	string	body	[optional] One of `textData`, `htmlData` and `templateUrl` is required
htmlData	string	body	[optional] One of `textData`, `htmlData` and `templateUrl` is required
templateUrl	string	body	[optional] One of `textData`, `htmlData` and `templateUrl` is required

Request

POST /campaign
  {
    "promotionId": 1,
    "subject": "Hello",
    "textData": "New promotion available at your store!",
    "isActive": true
  }

Response

Status: 201 CREATED

{
  "message": "Campaign created"
}

Send a campaign

This feature sends the campaign immediatly to the customers. You can choose to send a new campaign by filling the parameters or send an existing one by only providing an id.

POST /campaign/send

Parameters	Type	In	Description
id	number	body	[optional] If `id` is specified, the other parameters should be absent
promotionId	number	body	[optional] Only if `id` is not specified
subject	string	body	[required] Only if `id` is not specified
textData	string	body	[optional] Only if `id` is not specified. One of `textData`, `htmlData` and `templateUrl` is required
htmlData	string	body	[optional] Only if `id` is not specified. One of `textData`, `htmlData` and `templateUrl` is required
templateUrl	string	body	[optional] Only if `id` is not specified. One of `textData`, `htmlData` and `templateUrl` is required

Request

POST /campaign/send
  {
    "id": 1,
  }

OR

POST /campaign/send
  {
    "subject": "Hello",
    "textData": "New promotion available at your store!",
    "isActive": true
  }

Response

Status: 200 Ok

{
  "status": 200
}

Update a campaign

PUT /campaign/:id

Parameters	Type	In	Description
id	number	query	[required]
promotionId	number	body	[optional]
subject	string	body	[optional]
textData	string	body	[optional]
htmlData	string	body	[optional]
templateUrl	string	body	[optional]

Request

PUT /campaign/1
  {
    "counter": 10,
    "isActive": false
  }

Response

Status: 200 OK

{
  "message": "Campaign updated"
}

Delete a campaign

DELETE /campaign/:id

Parameters	Type	In	Description
id	number	query	[required]

Request

DELETE /campaign/1

Response

Status: 200 OK

{
  "message": "Campaign deleted"
}

Analytics endpoints

Get a shop's affluence

GET /analytics/affluence?start_date=xxx&end_date=yyy

Parameters	Type	In	Description
start_date	string	query	[required] DateString (ISO)
end_date	string	query	[required] DateString (ISO)

Request

GET /analytics/affluence?start_date=2022-06-23&end_date=2023-06-23

Response

Status: 200 OK

{
  "status": 200,
  "value": 20
}

Get a shop's clients count

GET /analytics/clients-count?start_date=xxx&end_date=yyy

Parameters	Type	In	Description
start_date	string	query	[required] DateString (ISO)
end_date	string	query	[required] DateString (ISO)

Request

GET /analytics/clients-count?start_date=2022-06-23&end_date=2023-06-23

Response

Status: 200 OK

{
  "status": 200,
  "value": 20
}

Get a shop's promotion ranking

GET /analytics/promotions-ranking?start_date=xxx&end_date=yyy

Parameters	Type	In	Description
start_date	string	query	[required] DateString (ISO)
end_date	string	query	[required] DateString (ISO)

Request

GET /analytics/promotions-ranking?start_date=2022-06-23&end_date=2023-06-23

Response

Status: 200 OK

{
  "status": 200,
  "promotionNames": ["best promotion", "second best promotion"],
  "values": [55, 24]
}

Get a shop's promotion checkout count

GET /analytics/promotion-checkout-count/:id?start_date=xxx&end_date=yyy

Parameters	Type	In	Description
id	string	query	[required] Promotion id
start_date	string	query	[required] DateString (ISO)
end_date	string	query	[required] DateString (ISO)

Request

GET /analytics/promotion-checkout-count/1?start_date=2022-06-23&end_date=2023-06-23

Response

Status: 200 OK

{
  "status": 200,
  "values": 55
}

Name		Name	Last commit message	Last commit date
Latest commit History 4,741 Commits
.github		.github
build		build
src		src
test		test
.dockerignore		.dockerignore
.env		.env
.env.dev		.env.dev
.eslintignore		.eslintignore
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.prettierrc		.prettierrc
Dockerfile		Dockerfile
Procfile		Procfile
README.md		README.md
docker-compose.yml		docker-compose.yml
nest-cli.json		nest-cli.json
package-lock.json		package-lock.json
package.json		package.json
start.sh		start.sh
tsconfig.build.json		tsconfig.build.json
tsconfig.json		tsconfig.json

FidelCly/api

Folders and files

Latest commit

History

Repository files navigation

api

Run locally

Execute a command inside the container

Available commands

Introduce code changes

API reference

Authentication endpoints

Register

Request

Response

Login

Request

Response

Users endpoints

Get a user

Request

Response

Get user's cards

Request

Response

Update a user

Request

Response

Delete a user

Request

Response

Shops endpoints

Get all shops

Request

Response

Get a shop

Request

Response

Get a shop's promotions

Request

Response

Get a shop's cards

Request

Response

Get a shop's campaigns

Request

Response

Create a shop

Request

Response

Update a shop

Request

Response

Delete a shop

Request

Response

Cards endpoints

Get a card

Request

Response

Create a card

Request

Response

Update a card

Request

Response

Delete a card

Request

Response

Promotions endpoints

Get a promotion

Request

Response

Create a promotion

Request

Response

Update a promotion

Request

Response

Delete a promotion

Packages