Getting Started with Instagram API

Introduction

Description of Instagram RESTful API.

Current limitations:

• Instagram service does not support cross origin headers for security reasons, therefore it is not possible to use Swagger UI and make API calls directly from browser.
• Modification API requests (POST, DELETE) require additional security scopes that are available for Apps created on or after Nov 17, 2015 and started in Sandbox Mode.
• Consider the Instagram limitations for API calls that depends on App Mode.

Warning: For Apps created on or after Nov 17, 2015 API responses containing media objects no longer return the data field in comments and likes nodes.

Last update: 2015-11-28

Instagram Developer Documentation: https://instagram.com/developer

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

| Parameter | Type | Description | | --- | --- | --- | | environment | Environment | The API environment. Default: Environment.Production | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | apiKeyCredentials | ApiKeyCredentials | The credential object for apiKey | | instagramAuthCredentials | InstagramAuthCredentials | The credential object for instagramAuth |

The API client can be initialized as follows:

import {
  Client,
  Environment,
  OAuthScopeInstagramAuthEnum,
} from 'apimatic-instagram-sdk';

const client = new Client({
  apiKeyCredentials: {
    'access_token': 'access_token'
  },
  instagramAuthCredentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthRedirectUri: 'OAuthRedirectUri',
    oAuthScopes: [
      OAuthScopeInstagramAuthEnum.Basic,
      OAuthScopeInstagramAuthEnum.Comments
    ]
  },
  timeout: 0,
  environment: Environment.Production,
});

Authorization

This API uses the following authentication schemes.

• api_key (Custom Query Parameter)
• instagram_auth (OAuth 2 Implicit Grant)

List of APIs

• Users
• Relationships
• Media
• Comments
• Likes
• Tags
• Locations
• Geographies

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError