An API Server made with Express

Instagram Directory API Server

This is the API server for the Instagram Directory project. The project contains is like a Yellow Pages but for Instagram Business

How it works

Install Dependencies

Note: Instagram Directory requires Node.js v4 or newer

npm install

Scripts

The API ships with several convenience commands (runnable via npm):

• npm start: start the server
• npm test: run unit tests (TBD)
• npm run dev: start the server with nodemon

Endpoints

Business

METHOD	ENDPOINT	USAGE	RETURNS
GET	/api/businesses/{id}	Get a business	business
GET	/api/businesses	Get a list of businesses	businesses

Categories

METHOD	ENDPOINT	USAGE	RETURNS
GET	/api/categories	Get a list of categories	categories
GET	/api/categories/{id}/subcategories	Get a category related subcategories	subcategories

Subcategories

METHOD	ENDPOINT	USAGE	RETURNS
GET	/api/subcategories	Get a list of subcategories	subcategories
GET	/subcategories/{id}/businesses	Get a subcategory related businesses	businesses
GET	/api/subcategories/{id}	Get a subcategory	subcategory

Contributing

Please fork and pull request against upstream master on a feature branch. Pretty please; provide unit tests and script fixtures in the test directory.

Continuous Integration

Travis tests every release. (TBD)