Stocka graph api documentation

Welcome to this api is constructed based on GraphQL API Architectural Principles. It includes two graphql operations including mutations, queries and Authorization and Authentication using JasonWebTokens.

To start the server navigate to the root directory and follow the following steps:

Navigate in .env file and add the following environment variables:

MONGO_URL = "mongodb://localhost:27017/stocka"

TOKEN_SECRET = "*****"

FORGOT_PASSWORD_TOKEN = "*********"

EMAIL = "[email protected]"

PASS = "****************"

CLIENT_URL="https://example.com"

ADMIN_URL="https://example.com"

Explanation of the above variables:

`MONGO_URL`: the database url and it is recommended to be the MONGO DB Url and that one is an example of connecting to a local server

`TOKEN_SECRET`: the string specifying the jwt secret and is a string of your choice but be different from the one for admin

`ADMIN_SECRET`: the string specifying the jwt secret and is a string of your choice

`FORGOT_PASSWORD_TOKEN`: the string specifying the forgot password secret and can be a string of your choice

`EMAIL`: the email to be used as the owner of the app in which the app will use when sending different mails to the users

`PASS`: the password for the above email

`CLIENT_URL`: the root link pointing to the client app in which the server is serving to be used when reseting the password for the user

`ADMIN_URL`: the root link pointing to the admin app in which the server is serving to be used when reseting the password for the user

`NODE_TLS_REJECT_UNAUTHORIZED = 0`: To avoid sign in certificate error

`ADMIN_EMAIL = [email protected]`: The admin email to be set at the start up of the server

`ADMIN_PASSWORD = ********`: The admin password to be set at the start up of the server

After entering the above environment variables in the .env file then in the terminal in the current folder run:

npm install

After installing the dependencies again in the terminal in the current folder run:

node app

This api contains Admin section and Client section

For Client:

Query operations :> By using the below queries pay attention to the declaration variables.

Every request to the server will require the authorization header with the following key values except `LoginClient` query and `ForgotPassword` query:

Authorization: Bearer token-value

The token-value specifies the one returned by the LoginClient query and is valid for 3 days

LoginClient :

query ($email: String!, $password: String!) {
  LoginClient(email: $email, password: $password) {
    token
    client {
      clientId
      username
      email
      phone
      role
      active
      gender
    }
  }
}

The are other many properties for the client which can be returned when working in any graphql tool

ShortTermProducts :

query ($clientId: ID!) {
  ShortTermProducts(clientId: $clientId) {
    productId
    name
    buyingPrice
    amount
    pricePerUnit
    dateOfEntry
    description
    dateOfExpry
    client {
      clientId
      email
      username
    }
  }
}

Noting here the client object will be found in many queries but don't wory it has many properties which will be found in the docs loaded by your grahql tool you prefer

LongTermProducts :

query ($clientId: ID!) {
  LongTermProducts(clientId: $clientId) {
    productId
    name
    buyingPrice
    amount
    pricePerUnit
    dateOfEntry
    description
    client {
      clientId
      username
      email
    }
  }
}

LongTermProductRecords :

query ($clientId: ID!) {
  LongTermProductRecords(clientId: $clientId) {
    recordId
    name
    productType
    buyingPrice
    sellingPrice
    amount
    dateOfEntry
    dateRecorded
    description
    client {
      username
      clientId
      email
    }
  }
}

ShortTermProductRecords :

query ($clientId: ID!) {
  ShortTermProductRecords(clientId: $clientId) {
    client
    recordId
    name
    productType
    buyingPrice
    sellingPrice
    amount
    dateOfEntry
    dateRecorded
    description
  }
}

Notifications:> All Notifications for the buyer will be returned by this query

query ($clientId: ID!) {
  Notifications(clientId: $clientId) {
    notificationId
    source
    message
    createdAt
    destination {
      __typename
      ... on Destination {
        destination
      }
      ... on Client {
        clientId
        username
        email
      }
    }
  }
}

AllPremiums:> All premium costs to be chosen by the client when paying for the next premium and this can be used by both admin and the client

For Client:

query (
  $clientId: ID
){
  AllPremiums(
    clientId: $clientId
  ){
    premiumId
    amountPaid
    duration
    createdAt

For Admin: ⚠️ Once you start working on admin section remember about this query

query (
  $adminId: ID
){
  AllPremiums(
    adminId: $adminId
  ){
    premiumId
    amountPaid
    duration
    createdAt

PaymentStatus: This will show the payment status for the client

query ($clientId: ID!) {
  PaymentStatus(clientId: $clientId) {
    paymentId
    client {
      clientId
      email
      username
    }
    paid
    expryDate
    refund
  }
}

ForgotPassword :> By this query will send the link to the email of the user if it was already registered and also already registered to Gmail client this means which is like this: *****@gmail.com but this issue will be fixed in the future

query ($email: String!) {
  ForgotPassword(email: $email) {
    success
    email
    message
  }
}

NB: Once you query the ForgotPassword query you may get error if you didn't allow less secure apps feature to your gmail account specified in .env flie Open the link: https://myaccount.google.com/lesssecureapps to enable it if you didn't done that.`

Mutation operations :> Also pay attention with the variables declaration and almost all variables are very well validated before making any effect to the data stored in the database.

Every request to the server will require the authorization header with the following key values except `RegisterClient` mutation and `ResetPassword` mutation even though this `ResetPassword` mutation will need the token in its arguments:

Authorization: Bearer token-value

The token-value specifies the one returned by the LoginClient query and is valid for 3 days

RegisterClient :> Please respect how the variables are declared by the query if you find any bug find the correction in the docs loaded from the server by your tool

mutation (
  $username: String!
  $email: String!
  $phone: String!
  $password: String!
  $confirmPassword: String!
  $gender: String!
) {
  RegisterClient(
    client: {
      username: $username
      email: $email
      phone: $phone
      password: $password
      confirmPassword: $confirmPassword
      gender: $gender
    }
  ) {
    username
    email
    phone
    role
    active
    createdAt
  }
}

AddShortTermProduct :

mutation (
  $buyingPrice: Float!
  $name: String!
  $amount: Float!
  $pricePerUnit: Float!
  $description: String
  $dateOfExpry: String!
  $clientId: ID!
) {
  AddShortTermProduct(
    product: {
      name: $name
      buyingPrice: $buyingPrice
      amount: $amount
      pricePerUnit: $pricePerUnit
      description: $description
      dateOfExpry: $dateOfExpry
    }
    clientId: $clientId
  ) {
    name
    buyingPrice
    amount
    pricePerUnit
    dateOfEntry
    description
    dateOfExpry
    client {
      clientId
      username
      email
    }
  }
}

UpdateShortTermProduct :

mutation (
  $buyingPrice: Float!
  $name: String!
  $amount: Float!
  $pricePerUnit: Float!
  $description: String
  $dateOfExpry: String!
  $clientId: ID!
  $productId: ID!
) {
  UpdateShortTermProduct(
    product: {
      name: $name
      buyingPrice: $buyingPrice
      amount: $amount
      pricePerUnit: $pricePerUnit
      description: $description
      dateOfExpry: $dateOfExpry
    }
    clientId: $clientId
    productId: $productId
  ) {
    name
    description
    buyingPrice
    amount
    dateOfExpry
    pricePerUnit
    client {
      clientId
      username
      email
    }
  }
}

DeleteShortTermProduct :

mutation ($clientId: ID!, $productId: ID!, $sellingPrice: Float!) {
  DeleteShortTermProduct(
    clientId: $clientId
    productId: $productId
    sellingPrice: $sellingPrice
  ) {
    success
    message
    product
  }
}

AddLongTermProduct :

mutation (
  $name: String!
  $buyingPrice: Float!
  $amount: Float!
  $pricePerUnit: Float!
  $description: String
  $clientId: ID!
) {
  AddLongTermProduct(
    product: {
      name: $name
      buyingPrice: $buyingPrice
      amount: $amount
      pricePerUnit: $pricePerUnit
      description: $description
    }
    clientId: $clientId
  ) {
    name
    amount
    buyingPrice
    pricePerUnit
    description
    client {
      username
      clientId
      email
    }
  }
}

UpdateLongTermProduct :

mutation (
  $name: String!
  $buyingPrice: Float!
  $amount: Float!
  $pricePerUnit: Float!
  $description: String
  $clientId: ID!
  $productId: ID!
) {
  UpdateLongTermProduct(
    product: {
      name: $name
      buyingPrice: $buyingPrice
      amount: $amount
      pricePerUnit: $pricePerUnit
      description: $description
    }
    clientId: $clientId
    productId: $productId
  ) {
    name
    buyingPrice
    amount
    pricePerUnit
    description
    client {
      clientId
      username
      email
    }
  }
}

DeleteLongTermProduct :

mutation ($clientId: ID!, $productId: ID!, $sellingPrice: Float!) {
  DeleteLongTermProduct(
    clientId: $clientId
    productId: $productId
    sellingPrice: $sellingPrice
  ) {
    success
    message
    product
  }
}

AddProductToRecord :

mutation (
  $name: String!
  $sellingPrice: Float!
  $productType: String!
  $amount: Float!
  $clientId: ID!
) {
  AddProductToRecord(
    record: {
      name: $name
      sellingPrice: $sellingPrice
      productType: $productType
      amount: $amount
    }
    clientId: $clientId
  ) {
    name
    buyingPrice
    sellingPrice
    amount
    productType
    dateRecorded
    dateOfEntry
    client {
      clientId
      username
      email
    }
  }
}

DeleteProductRecord :

mutation ($recordId: ID!, $clientId: ID!) {
  DeleteProductRecord(recordId: $recordId, clientId: $clientId) {
    success
    message
    record
    productType
  }
}

DeleteSelectedRecords :

mutation ($records: [ID!]!, $clientId: ID!) {
  DeleteSelectedRecords(records: $records, clientId: $clientId) {
    success
    message
    deletedRecords
    missedRecords
  }
}

When querying a client object type there is nested objects on it as they can be returned above and this can be applied everywhere you find this client object

UpdateCredentials :> Here it's all about updating user credentials except password

mutation (
  $clientId: ID!
  $username: String!
  $email: String!
  $phone: String!
  $gender: String!
  $password: String!
) {
  UpdateEmail(
    clientId: $clientId
    username: $username
    email: $email
    phone: $phone
    gender: $gender
    password: $password
  ) {
    clientId
    username
    email
    phone
    role
    active
    gender
    createdAt
    shortTermProducts {
      name
      buyingPrice
    }
    longTermProducts {
      name
      buyingPrice
    }
    shortTermProductRecords {
      name
      buyingPrice
      sellingPrice
    }
    longTermProductRecords {
      name
      buyingPrice
      sellingPrice
    }
  }
}

UpdatePassword :

mutation (
  $clientId: ID!
  $newPassword: String!
  $oldPassword: String!
  $confirmPassword: String!
) {
  UpdatePassword(
    clientId: $clientid
    oldPassword: $oldPassword
    newPassword: $newPassword
    confirmPassword: $confirmPassword
  ) {
    clientId
    username
    email
    phone
    role
    active
    gender
    createdAt
    shortTermProducts {
      name
      buyingPrice
    }
    longTermProducts {
      name
      buyingPrice
    }
    shortTermProductRecords {
      name
      buyingPrice
      sellingPrice
    }
    longTermProductRecords {
      name
      buyingPrice
      sellingPrice
    }
  }
}

ResetPassword :> By here the token being returned is valid for only two hours

mutation ($token: String!, $newPassword: String!, $confirmPassword: String!) {
  ResetPassword(
    token: $token
    newPassword: $newPassword
    confirmPassword: $confirmPassword
  ) {
    success
    email
    message
  }
}

DeleteNotification:> The notification can be deleted by the client except the one from ADMIN

mutation ($clientId: ID!, $notificationId: ID!) {
  DeleteNotification(clientId: $clientId, notificationId: $notificationId) {
    success
    message
    notificationId
  }
}

DeleteAccount:> Once the account is deleted all the data related to that client is lost

mutation ($clientId: ID!, $confirmPassword: String!) {
  DeleteAccount(clientId: $clientId, confirmPassword: $confirmPassword) {
    success
    message
    accountId
  }
}

That's all about user/client queries and mutations but it there is one more thing left about paying:=> Usually using MTN but there is a bug in that online service we are waiting for fixes

For Admin:

Query operations :> By using the below queries pay attention to the declaration variables.

Every request to the server will require the authorization header with the following key values except `LoginAdmin` query and `AdminForgotPassword` query

Security: Bearer token-value

The token-value specifies the one returned by the LoginAdmin query and is valid for 1 day

LoginAdmin:

query ($email: String!, $password: String!) {
  LoginAdmin(email: $email, password: $password) {
    token
    admin {
      adminId
      username
      email
      role
    }
  }
}

AllShortTermProducts:

query ($adminId: ID!) {
  AllShortTermProducts(adminId: $adminId) {
    productId
    name
    buyingPrice
    amount
    pricePerUnit
    dateOfEntry
    description
    dateOfExpry
    client {
      clientId
      email
      username
    }
  }
}

AllLongTermProducts:

query ($adminId: ID!) {
  AllLongTermProducts(adminId: $adminId) {
    productId
    name
    buyingPrice
    amount
    pricePerUnit
    dateOfEntry
    description
    client {
      clientId
      email
      username
    }
  }
}

AllShortTermProductRecords:

query ($adminId: ID!) {
  AllShortTermProductRecords(adminId: $adminId) {
    recordId
    name
    buyingPrice
    amount
    dateRecorded
    dateOfEntry
    description
    client {
      clientId
      email
      username
    }
  }
}

AllLongTermProductRecords:

query ($adminId: ID!) {
  AllLongTermProductRecords(adminId: $adminId) {
    recordId
    name
    buyingPrice
    amount
    dateRecorded
    dateOfEntry
    description
    client {
      clientId
      email
      username
    }
  }
}

AllNotifications:

query ($adminId: ID!) {
  AllNotifications(adminId: $adminId) {
    notificationId
    message
    createdAt
    source
    destination {
      __typename
      ... on Destination {
        destination
      }
      ... on Client {
        clientId
        email
        username
      }
    }
  }
}

AllPayments:

query ($adminId: ID!) {
  AllPayments(adminId: $adminId) {
    paymentId
    paid
    expryDate
    refund
    client {
      clientId
      email
      username
    }
  }
}

AllPremiums: This query is found in CLIENT section

AdminForgotPassword: Just like the CLIENT the logic is the same

query ($email: String!) {
  AdminForgotPassword(email: $email) {
    success
    email
    message
  }
}

Mutation operations :> Also pay attention with the variables declaration and almost all variables are very well validated before making any effect to the data stored in the database.

Every request to the server will require the authorization header with the following key values except `RegisterAdmin` mutation and `AdminResetPassword` mutation even though this `AdminResetPassword` mutation will need the token in its arguments:

Security: Bearer token-value

The token-value specifies the one returned by the LoginAdmin query and is valid for 2 days

RegisterAdmin:> Only one admin is registered in the app

mutation (
  $name: String!
  $email: String!
  $phone: String!
  $gender: String!
  $password: String!
  $confirmPassword: String!
) {
  RegisterAdmin(
    admin: {
      name: $name
      email: $email
      phone: $phone
      gender: $gender
      password: $password
      confirmPassword: $confirmPassword
    }
  ) {
    adminId
    username
    email
    phone
    gender
    role
  }
}

NotifyAllClients:

mutation ($adminId: ID!, $message: String!) {
  NotifyAllClients(adminId: $adminId, message: $message) {
    admin {
      username
      email
    }
    message
    success
  }
}

NotifyOneClient:

mutation ($adminId: ID!, $clientId: ID!, $message: String!) {
  NotifyOneClient(adminId: $adminId, message: $message, clientId: $clientId) {
    success
    message
    admin {
      username
      email
    }
  }
}

NotifyPaidClients:

mutation ($adminId: ID!, $message: String!) {
  NotifyPaidClients(adminId: $adminId, message: $message) {
    message
    success
    admin {
      username
      email
    }
  }
}

NotifyUnpaidClients:

mutation ($adminId: ID!, $message: String!) {
  NotifyUnpaidClients(adminId: $adminId, message: $message) {
    admin {
      username
      email
    }
    message
    success
  }
}

AdminDeleteNotification:

mutation ($adminId: ID!, $notificationId: ID!) {
  AdminDeleteNotification(adminId: $adminId, notificationId: $notificationId) {
    success
    message
    notificationId
  }
}

AdminSetCost: By here the admin can set the premium cost to be paid by clients for using his app if that cost doesn't exist

NB: the duration is expressed in floating numbers in range of [1-12] representing the months.

For example: 1-month ==> duration = 1 ; 2-weeks ==> duration = 0.5

mutation ($adminId: ID!, $premiumCost: Float!, $duration: Float!) {
  AdminSetCost(
    adminId: $adminId
    premiumCost: $premiumCost
    duration: $duration
  ) {
    success
    message
    premiumId
  }
}

AdminUpdateCost:

mutation (
  $adminId: ID!
  $premiumId: ID!
  $newPremiumCost: Float!
  $newDuration: Float!
) {
  AdminUpdateCost(
    adminId: $adminId
    premiumId: $premiumId
    newPremiumCost: $newPremiumCost
    newDuration: $newDuration
  ) {
    success
    message
    premiumId
  }
}

AdminDeleteCost:

mutation ($adminId: ID!, $premiumId: ID!) {
  AdminDeleteCost(adminId: $adminId, premiumId: $premiumId) {
    success
    message
    premiumId
  }
}

AdminResetPassword:

mutation ($token: String!, $newPassword: String!, $confirmPassword: String!) {
  AdminResetPassword(
    token: $token
    newPassword: $newPassword
    confirmPassword: $confirmPassword
  ) {
    success
    email
    message
  }
}

AdminUpdateCredentials:

mutation (
  $adminId: ID!
  $username: String!
  $email: String!
  $phone: String!
  $gender: String!
  $password: String!
) {
  AdminUpdateCredentials(
    adminId: $adminId
    username: $username
    email: $email
    phone: $phone
    gender: $gender
    password: $password
  ) {
    adminId
    username
    email
    phone
    gender
    role
    createdAt
  }
}

AdminUpdatePassword:

mutation (
  $adminId: ID!
  $oldPassword: String!
  $newPassword: String!
  $confirmPassword: String!
) {
  AdminUpdatePassword(
    adminId: $adminId
    oldPassword: $oldPassword
    newPassword: $newPassword
    confirmPassword: $confirmPassword
  ) {
    adminId
    username
    email
    phone
    gender
    role
    createdAt
  }
}

ToggleClientActivation:> Toggling the active property on clients if the client has not paid or not active

mutation ($adminId: ID!, $clientId: ID!) {
  ToggleClientActivation(adminId: $adminId, clientId: $clientId) {
    success
    message
    client {
      clientId
      email
      username
      active
    }
  }
}

AdminDeleteAccount:

mutation ($adminId: ID!, $confirmPassword: String!) {
  AdminDeleteAccount(adminId: $adminId, confirmPassword: $confirmPassword) {
    success
    message
    accountId
  }
}

NB: When the admin is deleted the new Admin properties can be found in the following path in the source code: `./utils/constants` in the object called: `adminAccRecover`

blaise-ndizeye / stocka-api Goto Github PK

stocka-api's Introduction

Stocka graph api documentation

MONGO_URL = "mongodb://localhost:27017/stocka"

TOKEN_SECRET = "*****"

FORGOT_PASSWORD_TOKEN = "*****"

EMAIL = "[email protected]"

PASS = "************"

CLIENT_URL="https://example.com"

ADMIN_URL="https://example.com"

Explanation of the above variables:

MONGO_URL: the database url and it is recommended to be the MONGO DB Url and that one is an example of connecting to a local server

TOKEN_SECRET: the string specifying the jwt secret and is a string of your choice but be different from the one for admin

ADMIN_SECRET: the string specifying the jwt secret and is a string of your choice

FORGOT_PASSWORD_TOKEN: the string specifying the forgot password secret and can be a string of your choice

EMAIL: the email to be used as the owner of the app in which the app will use when sending different mails to the users

PASS: the password for the above email

CLIENT_URL: the root link pointing to the client app in which the server is serving to be used when reseting the password for the user

ADMIN_URL: the root link pointing to the admin app in which the server is serving to be used when reseting the password for the user

NODE_TLS_REJECT_UNAUTHORIZED = 0: To avoid sign in certificate error

ADMIN_EMAIL = [email protected]: The admin email to be set at the start up of the server

ADMIN_PASSWORD = ********: The admin password to be set at the start up of the server

For Client:

Every request to the server will require the authorization header with the following key values except LoginClient query and ForgotPassword query:

Every request to the server will require the authorization header with the following key values except RegisterClient mutation and ResetPassword mutation even though this ResetPassword mutation will need the token in its arguments:

For Admin:

Every request to the server will require the authorization header with the following key values except LoginAdmin query and AdminForgotPassword query

Every request to the server will require the authorization header with the following key values except RegisterAdmin mutation and AdminResetPassword mutation even though this AdminResetPassword mutation will need the token in its arguments: