The PIPE is a logging proxy for multiple cannabis regulatory compliance engines. It's basically an intentional MITM for these upstream proxy.
Built before we learned about krakend.io. Also checkout openapi-cop.
- Clone this Repo
- Run
composer update - Copy ./etc/cre.ini.example to ./etc/cre.ini and configure it.
- Change owner and permissions on
./varandwebroot/outputso the web-server can read/write
Authentication must take place with the backend compliance reporting engine ("CRE").
The authentication for pipe itself is via some SSO/oAuth
PIPE then maintains a session state via headers, cookie or query-string parameters.
The authentication parameters are determined by the cre selection.
- BioTrackTHC ("BT") - Delaware*, Hawaii, Maine, New Mexico, North Dakota, Illinois, Puerto Rico
- Metrc ("FM") - Alaska, California, Colorado, Massachusetts, Nevada, Oregon
These systems authenticate with a company, username and password
curl \
--data 'company=123456789' \
--data 'username=user@example.com' \
--data 'password=DoNotTe11!'
These system require a program key and contact key. The program key is given to the software provider by Metrc and is configured in cre.ini. The contact key is from the licensee, its permissions will be determined by the user which acquires it. For best results, use a key from an administrator / super-user type role.
curl \
--data 'program-key=ABC123' \
--data 'license-key=ZYX987'
- Plants - (BT, FM)
- Inventory Lots (BT, FM)
- Laboratory Result (BT, FM)
- Products (LD, FM)
- Zones (aka: Areas, Rooms) - (BT, FM)
- Vehicles - BT