Skip to content

Instantly share code, notes, and snippets.

@Frdrcpeter007

Frdrcpeter007/README.md

Last active June 18, 2021 06:10
Show Gist options
  • Save Frdrcpeter007/ff8661051ef8af7c82ba6b28dd509135 to your computer and use it in GitHub Desktop.
Save Frdrcpeter007/ff8661051ef8af7c82ba6b28dd509135 to your computer and use it in GitHub Desktop.
Download ZIP
Le readme de l'application vistal
Raw
README.md

Routes de l'api

Partie administration

  1. Ajout d'un rôle /api/admin/roles/add => Type POST

    • Headers['auth-token']
    • type ['Admin' ou 'Client']
    • name

  2. Récupération des rôles selon le type /api/admin/roles/:type => Type GET

    • Headers['auth-token']

  3. Envoi de la réponse de validation d'un Shop /api/admin/shops/set/validation => Type PUT

    • Headers['auth-token']
    • shop
    • response (true or false)

  4. Ajout d'une catégorie /api/admin/categories/add => Type POST

    • Headers['auth-token']
    • name
    • icon

  5. Récupération des boutiques /api/admin/shops => Type GET

    • Headers['auth-token']

  6. Ajout d'un administrateur /api/admin/add => Type POST

    • role
    • fullName
    • phone
    • password

  7. Connexion d'un administrateur /api/admin/login => Type POST

    • phone
    • password

  8. Ajout d'un type de produit /api/admin/types/add => Type POST

    • Headers['auth-token']
    • category
    • name
    • icon

  9. Ajout d'une commune /api/admin/townships/add => Type POST

    • Headers['auth-token']
    • town
    • name
    • coordinates //eg. [long, lat]

  10. Ajout d'un livreur /api/admin/deliverymans/add => Type POST

    • Headers['auth-token']
    • fullName
    • phone
    • password
    • lines //eg. ['idcommune1', 'idcommune2', etc.]

  11. Liste de client dans la plateforme /api/admin/clients/list => Type GET

    • Headers['auth-token']

  12. Détails sommaire des informations d'un client /api/admin/clients/summary/:id => Type GET

    • Headers['auth-token']

  13. Suspension ou retrait de supension de compte /api/admin/clients/toggle/:id => Type PUT

    • Headers['auth-token']

  14. Détails sommaire des informations d'un commerce /api/admin/shops/summary/:id => Type GET

    • Headers['auth-token']

  15. Produits d'un commerce /api/admin/products/for/shop/:shop => Type GET

    • Headers['auth-token']

  16. Récupération des livreurs /api/admin/deliverymans => Type GET

    • Headers['auth-token']

  17. Détails sommaire des informations d'un livreur /api/admin/deliverymans/summary/:id => Type GET

    • Headers['auth-token']

  18. Suspension ou retrait de supension de compte livreur /api/admin/deliverymans/toggle/:id => Type PUT

    • Headers['auth-token']

  19. Assignation d'une nouvelle ligne de livraison /api/admin/deliverymans/set/line/:id => Type PUT

    • Headers['auth-token']
    • line

  20. Liste des utilisateurs /api/admin/list => Type GET

    • Headers['auth-token']

  21. Détails des informations de l'utilisateurs /api/admin/details/:id => Type GET

    • Headers['auth-token']

  22. Liste des catégories /api/admin/categories/list => Type GET

    • Headers['auth-token']

  23. Activer ou désactiver une catégorie /api/admin/categories/toggle/:id => Type PUT

    • Headers['auth-token']

  24. Suppression d'une catégorie /api/admin/categories => Type delete

    • Headers['auth-token']

  25. Listes des commandes /api/admin/orders/list => Type GET

    • Headers['auth-token']

  26. Détails de la commande /api/admin/orders/details/:id => Type GET

    • Headers['auth-token']

  27. Ajout d'un client (vendeur ou acheteur) /api/admin/clients/add => Type POST

    • Headers[auth-token]
    • role
    • fullName
    • phone
    • nameShop (obligatoire que pour vendeur)
    • longitude (obligatoire que pour vendeur)
    • latitude (obligatoire que pour vendeur)
    • category (obligatoire que pour vendeur)
    • address (obligatoire que pour vendeur)
    • logo (que pour vendeur)
    • cover (que pour vendeur)

  28. Liste des pays /api/admin/countries/list => Type GET

  29. Ajout d'une ville d'un Pays /api/admin/towns/add => Type POST

    • Headers['auth-token']
    • country
    • name

  30. Récupération des villes d'un pays /api/admin/towns/for/country/:country => Type GET

  31. Activer ou désactiver un type de produit /api/admin/types/toggle/:id => Type PUT

    • Headers['auth-token']

  32. Activer ou désactiver un commerce (shop) /api/admin/shops/toggle/:id => Type PUT

    • Headers['auth-token']

  33. Mise à jour d'un type de produit /api/admin/types/update/:id => Type PUT

    • Headers['auth-token']
    • name (optional)
    • icon (optional)

  34. Mise à jour d'une catégorie d'un shop /api/admin/categories/update/:id => Type PUT

    • Headers['auth-token']
    • name (optional)
    • icon (optional)

  35. Mise à jour des informations d'un produit relatif à un shop /api/admin/products/update/:id => Type PUT

    • Headers['auth-token']
    • type (optional)
    • name (optional)
    • describe (optional)
    • images (optional) //eg. ['https://lien_vers_image.png', 'https://lien_vers_image.png', etc]
    • price (optional)
    • pricePromo (optional)
    • onDiscount (optional) //eg. true ou false

  36. Ajout d'un produit pour un shop /api/admin/products/publish => Type POST

    • Headers['auth-token']
    • type
    • shop
    • name
    • describe
    • images //eg. ['https://lien_vers_image.png', 'https://lien_vers_image.png', etc]
    • price

  37. Activer ou désactiver le produit commerce (shop) /api/admin/products/toggle/:id => Type PUT

    • Headers['auth-token']

  38. Récupération de la liste de type de produit /api/admin/types/list => Type GET

    • Headers['auth-token']

  39. Récupération de la liste de commande en cours de livraison /api/admin/orders/list/in/progress => Type GET

    • Headers['auth-token']

  40. Listes des commandes avec limite /api/admin/orders/list/:limit => Type GET

    • Headers['auth-token']

  41. Suspendre ou réactiver une ligne /api/admin/townships/toggle/:id => Type PATCH

    • Headers['auth-token']

  42. Retrait d'une ligne de livraison /api/admin/deliverymans/remove/line/:id => Type PUT

    • Headers['auth-token']
    • line

  43. Récupération des lignes de livraison /api/admin/deliverymans/line/:id => Type GET

    • Headers['auth-token']

  44. Récupération des townships /api/admin/townships/list/:town => Type GET

    • Headers['auth-token']

  45. Assigner la commande à un livreur /api/admin/orders/assign/:order => Type PATCH

    • Headers['auth-token']
    • deliveryman

  46. Récupération des stats d'une ligne avant d'assigner une commande /api/admin/deliverymans/stats/line/:line => Type GET

    • Headers['auth-token']

  47. Mettre à jour les informations d'un role /api/admin/roles/:id => Type PATCH

    • Headers['auth-token']
    • type ['Admin' ou 'Client'] (optional)
    • name (optional)

  48. Activer ou désactiver un role /api/admin/roles/toggle/:id => Type PUT

    • Headers['auth-token']

  49. Mettre à jour les informations d'un admin /api/admin => Type PATCH

    • Headers['auth-token']
    • fullName (optional)
    • phone (optional)

  50. Activer ou désactiver un admin /api/admin/toggle/:id => Type PUT

    • Headers['auth-token']

Partie cliente

  1. Upload des fichiers /api/upload => Type POST

    • file-s3 (FormData)

  2. Récupération des rôles selon le type /api/roles => Type GET

  3. Inscription d'un client (vendeur ou acheteur) /api/clients/register => Type POST

    • role
    • fullName
    • phone
    • nameShop (obligatoire que pour vendeur)
    • longitude (obligatoire que pour vendeur)
    • latitude (obligatoire que pour vendeur)
    • category (obligatoire que pour vendeur)
    • address (obligatoire que pour vendeur)
    • logo (que pour vendeur)
    • cover (que pour vendeur)

  4. Activation du compte client /api/clients/activation => Type PUT

    • Headers['auth-token']
    • code

  5. Connexion d'un client (vendeur ou acheteur) /api/clients/login => Type POST

    • phone

  6. Récupération des catégories sans limite /api/categories/gets => Type GET

    • Headers['token-client'] (optionnal)

  7. Récupération des catégories avec limite /api/categories/gets/:limit => Type GET

    • Headers['token-client'] (optionnal)

  8. Récupération des boutiques sans limite /api/shops/gets => Type GET

    • Headers['token-client'] (optionnal)

  9. Récupération des boutiques avec limite /api/shops/gets/:limit => Type GET

    • Headers['token-client'] (optionnal)

  10. Publication d'un produit par une boutique /api/products/publish => Type POST

    • Headers['token-client']
    • type
    • shop
    • name
    • describe
    • images //eg. ['https://lien_vers_image.png', 'https://lien_vers_image.png', etc]
    • price

  11. Récupération des produits récemments publié sans limite /api/products/gets => Type GET

    • Headers['token-client'] (optionnal)

  12. Récupération des produits récemments publié avec limite /api/products/gets/:limit => Type GET

    • Headers['token-client'] (optionnal)

  13. Mettre ou rétirer dans ces favoris un produit /api/products/add/whiteList/toggle => Type POST

    • Headers['token-client']
    • product

  14. Récupération des détails d'un produit /api/products/details/:id => Type GET

    • Headers['token-client'] (optionnal)

  15. Récupération des produits similaire sans prendre le nom du produit /api/products/similar/:id/:shop/:limit => Type GET

    • Headers['token-client'] (optionnal)

  16. Récupération des produits similaire prenant en compte le nom du produit /api/products/similar/:id/:shop/:limit/:nameProduct => Type GET

    • Headers['token-client'] (optionnal)

  17. Récupération des produits en favoris d'un autre client /api/products/whiteList/client/:client => Type GET

    • Headers['token-client']

  18. Passation d'une commande /api/orders/save => Type POST

    • Headers['token-client']
    • township
    • address
    • products //eg. [{id: "xxx", qte: 23, price: 23.5, shop: "xxx"}]

  19. Follow ou unfollow une autre boutiques /api/follow/toggle => Type POST

    • Headers['token-client']
    • shop

  20. Récupération des produits au top (qui a fait le plus de revenue) avec limite /api/products/top/:limit => Type GET

    • Headers['token-client']

  21. Récupération des produits au top (qui a fait le plus de revenue) sans limite /api/products/top => Type GET

    • Headers['token-client']

  22. Récupération de tous les clients d'une boutiques /api/shops/all/clients/:shop => Type GET

    • Headers['token-client']

  23. Récupération des détails d'une commande /api/orders/details/:id => Type GET

    • Headers['token-client']

  24. Récupération de la liste des commandes d'une boutiques /api/orders/list/for/shop/:shop => Type GET

    • Headers['token-client']

  25. Récupération de la liste des commandes d'un client /api/orders/list/for/client => Type GET

    • Headers['token-client']

  26. Récupération de la commande via sa réference /api/orders/by/reference/:reference => Type GET

    • Headers['token-client']

  27. Définir le paiement d'une commande /api/orders/set/payed => Type PUT

    • Headers['token-client']
    • order

  28. Mise à jour des informations du client /api/clients/update => Type PUT

    • Headers['token-client']
    • fullName (optional)
    • address (optional) //eg. ['Lemba av.xxxx', 'Lemba av.yyyyy']
    • profile (optional)
    • email (optional)

  29. Récupération des détails d'un shop /api/shops/details/:id/:limitProduct => Type GET

    • Headers['token-client'] (optionnal)

  30. Récupération des tops boutiques avec limite /api/shops/top/:limit => Type GET

    • Headers['token-client'] (optionnal)

  31. Récupération des tops boutiques sans limite /api/shops/top/:limit => Type GET

    • Headers['token-client'] (optionnal)

  32. Récupération des boutiques proches d'un lieu à 2,5 Km à la ronde /api/shops/near?long=xxxxx&lat=xxxxxx => Type GET

    • Headers['token-client'] (optionnal)

  33. Récupération des produits pour un type donnée /api/products/for/type/:type => Type GET

    • Headers['token-client']

  34. Récupération des types des produits sans limite /api/types/gets => Type GET

    • Headers['token-client']

  35. Récupération des types des produits avec limite /api/types/gets/:limit => Type GET

    • Headers['token-client']

  36. Récupération des communes /api/townships/for/town/:town => Type GET

    • Headers['token-client']

  37. Connexion d'un livreur /api/deliverymans/login => Type POST

    • phone
    • password
    • deviceToken

  38. Récupération du profile utilisateur /api/clients/profile => Type GET

    • Headers['token-client']

  39. Récupération des boutiques d'une catégorie /api/shops/for/category/:category?long=xxxxx&lat=xxxxxx => Type GET

  40. Récupération des tops boutiques d'une catégorie avec limite /api/shops/top/for/category/:category/:limit => Type GET

  41. Récupération des tops boutiques sans limite /api/shops/top/for/category/:category/:limit => Type GET

  42. Prendre responsablité de livraison /api/orders/take => Type PUT

    • Headers['token-delivery']
    • order

  43. Liste des commandes non-prise en charge par des livreurs de la zone d'un livreur /api/orders/list/free/zone => Type GET

    • Headers['token-delivery']

  44. Mise à jour des informations du shop /api/shops/update/:shop => Type PUT

    • Headers['token-client']
    • name (optional)
    • logo (optional)
    • cover (optional)
    • address (optional)

  45. Récupération des pays /api/countries/list => Type GET

  46. Récupération des villes d'un pays /api/towns/for/country/:country => Type GET

  47. Connexion d'un client (vendeur ou acheteur) via OTP /api/clients/otp => Type POST

    • phone
    • otp

  48. Paiement par mobile money d'une commande /api/payments/mobile/drc => Type POST

    • Headers['token-client']
    • phone
    • order
    • numOrder

  49. Définir une commande comme livré /api/orders/set/delivered/:id => Type PUT

    • Headers['token-delivery']
    • numOrder

  50. Récupération des commandes d'un livreur /api/orders/list/for/deliveryman => Type GET

    • Headers['token-delivery']

  51. Récupération des commandes terminés d'un livreur /api/orders/list/finished/for/deliveryman => Type GET

    • Headers['token-delivery']

  52. Noter un livreur ou un restaurant /api/reviews/publish => Type POST

    • Headers['token-client']
    • type (shop ou delivery)
    • note
    • objet
    • comment

  53. Recherche du restaurant /api/shops/search?long=xxxxx&lat=xxxxxx => TYPE POST

    • search

  54. Récupération des types des produits d'une catégorie de commerce sans limite /api/types/gets/for/:category => Type GET

  55. Récupération des types des produits d'une catégorie de commerce avec limite /api/types/gets/for/:category/:limit => Type GET

  56. Le note des clients pour un shop /api/reviews/for/shop/:shop => Type GET

    • Headers['token-client']

Contributor

@Frdrcpeter007

Happy code 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment