Skip to content

This is a RESTful API project with Node.js and MongoDB to integrate the Pipedrive and Bling.

Notifications You must be signed in to change notification settings

maa-targino/rest-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API project to integrate Pipedrive and Bling

Introduction:

  • This is a REST API project that integrates Pipedrive (CRM) and Bling (ERP) using Node.js and the MongoDB database. The API gets the deals from Pipedrive with its status 'won' and make an order request on Bling, registering it in the database.

logo

Requirements:

Installing the code-editor

  • You can use Visual Studio Code for the project development. Click here and install it.

Installing Git

  • You can track your code changes with Git version control software. Click here and install it.

Installing Node.js

  • You can download the LTS version of the Node.js source code by clicking here and accessing its download page.

Installing API Client

  • You can download the Insomnia or Postman API client for thesting the HTTP requests.

Creating the Database

  • You can sing-up for MongoDB Atlas to use the free cloud-hosted option of its DBaaS by clicking here and creating an account.

Authentication:

You will need to have the API tokens for authentication:

Starting the project:

  • Open you project folder with Visual Studio Code and press CTRL + ' to open the terminal.

  • Run the npm install command to install the npm package manager.

  • After that, run npm init to initialize its packages.

  • If you prefer, you can also use the yarn package manager running npm install --global yarn.

  • You can add an .env file and load your environment variables using the dotenv module. Run npm install dotenv to install it.

  • The nodemon is a tool that restarts applications after file changes. Run npm install --save-dev nodemon to install it.

  • Express is a module to build APIs that supports routing and middleware. Run npm install --save-dev express to install it.

  • Axios is a promise based HTTP client that helps making requests with Node.js. Run npm install --save-dev axios to install it.

Endpoints:

GET /status

Is returns the current status of the API.

 

GET /deals

It lists all deals from Pipedrive. For more information, access this documentation on Pipedrive Developers.

 

GET /deals/won

It only fetches deals with status 'won'. The status is a query parameter that can be supplied in the request to return deals with specific status.

 

POST /deals

It creates a new deal on Pipedrive with the fields informaton that were supplied. For more information, access this documentation on Pipedrive Developers.

 

POST /orders

It creates an order request on Bling with the provided fields. For more information, access this documentation on Bling Ajuda.

 

POST /save

It creates a new resource in a collection on MongoDB Atlas database, with the provided JSON. For more information, access the MongoDB Documentation.

Contact:

 

Marco Targino

Gmail Linkedin GitHub Stack Overflow

About

This is a RESTful API project with Node.js and MongoDB to integrate the Pipedrive and Bling.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published