Skip to content

Add an Express route that returns a user's Instagram photos.

License

Notifications You must be signed in to change notification settings

personal-api/plugin-instagram

Repository files navigation

Instagram Plugin Build Status codecov

Add recent photos to JS Personal API

Install

$ npm install --save @personal-api/plugin-instagram

Usage

In your JS Personal API plugins file instantiate the InstagramPlugin class, passing the following required options defined below under Options, and call apply() with the Express app object.

import InstagramPlugin from '@personal-api/plugin-instagram';

export default (app) => {
  const Instagram = new InstagramPlugin({
    accessToken: '0000000000.0000000.00000000000000000000000000000000',
    onError: () => {},
    onSuccess: () => {},
    userId: '0000000000'
  });

  Instagram.apply(app);
};

Options

Configuration options for the plugin class.

accessToken

Type: String

Your Instagram access token for API access.

count

Type: Number

Default: 3

(Optional) The maximum number of pagination pages to fetch from Instagram.

middleware

Type: Function

(Optional) An Express middleware run before the route's controller.

onError

Type: Function

The error handler for API responses.

onSuccess

Type: Function

The success handler for API responses.

userId

Type: String

The Instagram User ID for API access.

License

MIT © Chris Vogt