@pimex/gateway

Pimex data exporter

Microservice for export data from Pimex in different formarts

Export leads

Export leads from accounts and boards

Formarts

From	XLSX	JSON	CSV
Accounts	✅	X	X
Boards	X	X	X

Installation

  npm install

Config files

All configuration files must be inside the config folder. It is important that this directory is never uploaded to the repository with changes.

config.json

The projec need an config.json file for work.

{
 "paths": {
   "firebase-key": "config/firebase-key.json"
  }
}

.env

Set env variables, the fields with * are required

Field	Description
ENV	Project environment, (production, dev)
PORT	Port where the server will start, (3000)
*MONGO_URI	Mongo DB url, (mongodb://localhost:27017/exports)

API Reference

Export leads from account

  POST /accounts/${accountId}/leads/

Parameter	Type	Description
accountId	string	* Enterprice account ID

Get all exports

  GET /

Get export by Id

  POST /accounts/${exportId}

Parameter	Type	Description
exportId	string	* Export id

Get all exports from account

  GET /accounts/${accountId}

Parameter	Type	Description
accountId	string	* Enterprice account ID

Get all exports from accounts

  GET /accounts

Authors

• @jquiceno