adriano.andrade
/
settings
mirror of https://github.com/AdrianoRobson/billing-api/settings
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat: add routes for external API requests and operation logs, add sessionId property

main
adriano 2024-07-30 12:01:48 -03:00
parent b96b05ad83
commit 14c0303c78
7 changed files with 214 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
app.js
View File

@ -28,13 +28,13 @@ const notFoundMiddlware = require('./middleware/not-found')
//middleware
app.set('trust proxy', 1)
app.use(rateLimiter({
windowMs: 15 * 60 * 1000,
max: 60,
}))
// app.use(rateLimiter({
// windowMs: 15 * 60 * 1000,
// max: 60,
// }))
// Security packages
app.use(helmet())
// app.use(helmet())
app.use(cors())
app.use(xss())

97
controllers/apiUsagePricing.js
View File

@ -7,6 +7,8 @@ const {
const API_Usage = require("../models/API_Usage.js")
const billingSumUsage = require("../utils/billingSumUsage.js")
const moment = require('moment')
const API_Call = require("../models/API_Call.js")
const API_Operation = require("../models/API_Operation.js")
const setApiPricing = async (req, res) => {
@ -18,15 +20,22 @@ const setApiPricing = async (req, res) => {
'billingBy',
'billingUnit'])
const apiPricing = await API_Pricing.create({
provider: provider.trim().toLowerCase(),
product: product.trim().toLowerCase(),
const normalizedProvider = provider.trim().toLowerCase()
const normalizedProduct = product.trim().toLowerCase()
const filter = { provider: normalizedProvider, product: normalizedProduct }
const update = {
provider: normalizedProvider,
product: normalizedProduct,
currency,
price,
billingBy,
billingUnit,
type
})
}
const options = { new: true, upsert: true }
const apiPricing = await API_Pricing.findOneAndUpdate(filter, update, options)
res.status(StatusCodes.OK).json({ apiPricing })
}
@ -37,26 +46,17 @@ const registerUsage = async (req, res) => {
product,
usage,
callerId,
sessionId,
companyId,
quantityOfOperationAttempts,
chosenOperation,
requestLogsOpenAI,
responseErrorLogsOpenAI,
quantityOfCallsToFalconFlowAPI,
requestLogsFalconFlowAPI,
responseErrorLogsFalconFlowAPI,
} = req.body
mustContainProperties(req, [
'companyId',
'callerId',
'sessionId',
'quantityOfOperationAttempts',
'chosenOperation',
'requestLogsOpenAI',
// 'responseErrorLogsOpenAI',
'quantityOfCallsToFalconFlowAPI',
'requestLogsFalconFlowAPI',
// 'responseErrorLogsFalconFlowAPI',
'provider',
'product',
'usage',
@ -75,13 +75,8 @@ const registerUsage = async (req, res) => {
provider: provider.trim().toLowerCase(),
product: product.trim().toLowerCase(),
callerId,
sessionId,
quantityOfOperationAttempts,
chosenOperation,
requestLogsOpenAI,
responseErrorLogsOpenAI,
quantityOfCallsToFalconFlowAPI,
requestLogsFalconFlowAPI,
responseErrorLogsFalconFlowAPI,
usage,
price,
billingBy,
@ -98,6 +93,62 @@ const registerUsage = async (req, res) => {
}
const registerAPICall = async (req, res) => {
const {
callerId,
companyId,
sessionId,
type,
requestLogs,
responseError,
quantityOfAPICall
} = req.body
mustContainProperties(req, [
'companyId',
'callerId',
'sessionId'
])
const apiCall = await API_Call.create({
callerId,
companyId,
sessionId,
type,
requestLogs,
responseError,
quantityOfAPICall
})
res.status(StatusCodes.OK).json({ apiCall })
}
const registerOperation = async (req, res) => {
const {
callerId,
companyId,
sessionId,
operation,
} = req.body
mustContainProperties(req, [
'companyId',
'callerId',
'sessionId',
'operation'
])
const apiOperation = await API_Operation.create({
callerId,
companyId,
sessionId,
operation
})
res.status(StatusCodes.OK).json({ apiOperation })
}
const getUsage = async (req, res) => {
const { startDate, endDate, companyId, } = req.body
@ -124,5 +175,7 @@ const getUsage = async (req, res) => {
module.exports = {
setApiPricing,
registerUsage,
registerAPICall,
registerOperation,
getUsage
}

36
models/API_Call.js 100644
View File

@ -0,0 +1,36 @@
const mongoose = require('../db/connect')
const { Schema } = mongoose
const apiCall = new Schema({
companyId: {
type: String,
required: true,
},
callerId: {
type: String,
required: true,
},
sessionId: {
type: String,
required: true,
},
type: {
type: String,
enum: ['IAProvider', 'externalAPI',],
},
requestLogs: {
type: String,
},
responseError: {
type: String,
},
quantityOfAPICall: {
type: String,
},
}, { timestamps: true })
const API_Call = mongoose.model('API_Call', apiCall)
module.exports = API_Call

27
models/API_Operation.js 100644
View File

@ -0,0 +1,27 @@
const mongoose = require('../db/connect')
const { Schema } = mongoose
const apiOperation = new Schema({
companyId: {
type: String,
required: true,
},
callerId: {
type: String,
required: true,
},
sessionId: {
type: String,
required: true,
},
operation: {
type: String,
required: true,
},
}, { timestamps: true })
const API_Operation = mongoose.model('API_Operation', apiOperation)
module.exports = API_Operation

50
models/API_Usage.js
View File

@ -11,33 +11,37 @@ const apiUsage = new Schema({
type: String,
required: true,
},
sessionId: {
type: String,
required: true,
},
quantityOfOperationAttempts: {
type: String,
required: true,
},
chosenOperation: {
type: String,
required: true,
},
requestLogsOpenAI: {
type: String,
required: true,
},
responseErrorLogsOpenAI: {
type: String,
},
quantityOfCallsToFalconFlowAPI: {
type: String,
required: true,
},
requestLogsFalconFlowAPI: {
type: String,
required: true,
},
responseErrorLogsFalconFlowAPI: {
type: String,
required: true,
},
// chosenOperation: {
// type: String,
// required: true,
// },
// requestLogsOpenAI: {
// type: String,
// required: true,
// },
// responseErrorLogsOpenAI: {
// type: String,
// },
// quantityOfCallsToFalconFlowAPI: {
// type: String,
// required: true,
// },
// requestLogsFalconFlowAPI: {
// type: String,
// required: true,
// },
// responseErrorLogsFalconFlowAPI: {
// type: String,
// required: true,
// },
provider: {
type: String,
required: true,

4
routes/apiPriceRoute.js
View File

@ -1,11 +1,13 @@
const express = require('express')
const router = express.Router()
const { authorization, } = require('../middleware/authentication')
const { setApiPricing, registerUsage, getUsage} = require('../controllers/apiUsagePricing')
const { setApiPricing, registerUsage, getUsage, registerAPICall, registerOperation} = require('../controllers/apiUsagePricing')
router.route('/create').post(authorization, setApiPricing)
router.route('/usage').post(authorization, registerUsage)
router.route('/report').post(authorization, getUsage)
router.route('/api-call').post(authorization, registerAPICall)
router.route('/api-operation').post(authorization, registerOperation)

46
swagger.yaml
View File

@ -24,68 +24,82 @@ paths:
properties:
companyId:
type: string
description: Company identifier
example: "1"
callerId:
type: string
description: Identifier of the person who made the call
example: "17988310949"
quantityOfOperationAttempts:
type: string
description: Number of attempts to perform the operation made by the person who made the call
example: "2"
chosenOperation:
type: string
description: Operation chosen by the person who made the call
example: "unblokUser"
requestLogsOpenAI:
type: string
description: Response logs of requests made to openai
example: "{}"
responseErrorLogsOpenAI:
type: string
description: Openai error request response logs
example: "{}"
quantityOfCallsToFalconFlowAPI:
type: string
description: Number of requests made to third-party api
example: "2"
requestLogsFalconFlowAPI:
type: string
description: Response logs of requests made to third-party api
example: "{}"
responseErrorLogsFalconFlowAPI:
type: string
description: Third-party api error request response logs
example: "{}"
provider:
type: string
description: Identifier of the organization providing the AI ​​solution
example: "openai"
product:
type: string
description: Product provided by the organization that is providing AI solution
example: "whisper"
usage:
type: integer
description: "Using the API. The product Whisper should be sent in seconds"
example: 15
type: string
description: "Time in seconds"
example: "15"
required:
- companyId
- callerId
- quantityOfOperationAttempts
- chosenOperation
- requestLogsOpenAI
- responseErrorLogsOpenAI
- quantityOfCallsToFalconFlowAPI
- requestLogsFalconFlowAPI
- responseErrorLogsFalconFlowAPI
- provider
- product
- usage
required: true
responses:
'200':
description: ''
headers: {}
description: 'Successful response'
content:
application/json:
example:
apiUsage:
companyId: "1"
callerId: "17988310949"
quantityOfOperationAttempts: "2"
chosenOperation: "unblokUser"
requestLogsOpenAI: "{}"
responseErrorLogsOpenAI: "{}"
quantityOfCallsToFalconFlowAPI: "2"
requestLogsFalconFlowAPI: "{}"
responseErrorLogsFalconFlowAPI: "{}"
provider: "openai"
product: "whisper"
usage: 15
price: "0.006"
billingBy: "minute"
billingUnit: 1
total_cost: "0.0015000000"
_id: "66a8df390cbb7371c4ade653"
createdAt: "2024-07-30T12:40:25.782Z"
updatedAt: "2024-07-30T12:40:25.782Z"
__v: 0
deprecated: false
security:
- bearer: []