pinterest-apilib v1.0.4
Getting Started with Pinterest API
Building
Install
Install the library using npm from: https://www.npmjs.com/package/pinterest-apilib
npm i pinterest-apilib
Requirements
The SDK relies on Node.js and npm (to resolve dependencies). You can download and install Node.js and npm from the official Node.js website.
NOTE: npm is installed by default when Node.js is installed.
Verify Successful Installation
Run the following commands in the command prompt or shell of your choice to check if Node.js and npm are successfully installed:
Node.js:
node --version
npm:
npm --version
Install Dependencies
- To resolve all dependencies, go to the SDK root directory and run the following command with npm:
npm install
- This will install all dependencies in the node_modules folder.
Installation
The following section explains how to use the generated library in a new project.
1. Initialize the Node Project
Open an IDE/text editor for JavaScript like Visual Studio Code. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Click on File and select Open Folder. Select an empty folder of your project, the folder will become visible in the sidebar on the left.
- To initialize the Node project, click on Terminal and select New Terminal. Execute the following command in the terminal:
npm init --y
2. Add Dependencies to the Client Library
- The created project manages its dependencies using its
package.json
file. In order to add a dependency on the Pinterest APILib client library, double click on thepackage.json
file in the bar on the left and add the dependency to the package in it.
- To install the package in the project, run the following command in the terminal:
npm install
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. |
oAuthClientId | string | OAuth 2 Client ID |
oAuthClientSecret | string | OAuth 2 Client Secret |
oAuthRedirectUri | string | OAuth 2 Redirection endpoint or Callback Uri |
oAuthToken | OAuthToken | Object for storing information about the OAuth token |
oAuthScopes | OAuthScopeEnum[] |
HttpClientOptions
Parameter | Type | Description |
---|---|---|
timeout | number | Timeout in milliseconds. |
httpAgent | any | Custom http agent to be used when performing http requests. |
httpsAgent | any | Custom https agent to be used when performing http requests. |
retryConfig | Partial<RetryConfiguration> | Configurations to retry requests. |
RetryConfiguration
Parameter | Type | Description |
---|---|---|
maxNumberOfRetries | number | Maximum number of retries. Default: 0 |
retryOnTimeout | boolean | Whether to retry on request timeout. Default: true |
retryInterval | number | Interval before next retry. Used in calculation of wait time for next request in case of failure. Default: 1 |
maximumRetryWaitTime | number | Overall wait time for the requests getting retried. Default: 0 |
backoffFactor | number | Used in calculation of wait time for next request in case of failure. Default: 2 |
httpStatusCodesToRetry | number[] | Http status codes to retry against. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] |
httpMethodsToRetry | HttpMethod[] | Http methods to retry against. Default: ['GET', 'PUT'] |
The API client can be initialized as follows:
const client = new Client({
timeout: 0,
environment: Environment.Production,
oAuthClientId: 'OAuthClientId',
oAuthClientSecret: 'OAuthClientSecret',
oAuthRedirectUri: 'OAuthRedirectUri',
oAuthToken: null,
oAuthScopes: null,
})
Authorization
This API uses OAuth 2 Authorization Code Grant
.
Authorization Code Grant
Your application must obtain user authorization before it can execute an endpoint call incase this SDK chooses to use OAuth 2.0 Authorization Code Grant. This authorization includes the following steps
1. Obtain user consent
To obtain user's consent, you must redirect the user to the authorization page.The buildAuthorizationUrl()
method creates the URL to the authorization page. You must pass the scopes for which you need permission to access.
const authUrl = client.authorizationCodeAuthManager.buildAuthorizationUrl();
2. Handle the OAuth server response
Once the user responds to the consent request, the OAuth 2.0 server responds to your application's access request by redirecting the user to the redirect URI specified set in Configuration
.
If the user approves the request, the authorization code will be sent as the code
query string:
https://example.com/oauth/callback?code=XXXXXXXXXXXXXXXXXXXXXXXXX
If the user does not approve the request, the response contains an error
query string:
https://example.com/oauth/callback?error=access_denied
3. Authorize the client using the code
After the server receives the code, it can exchange this for an access token. The access token is an object containing information for authorizing client requests and refreshing the token itself.
try {
const token = await client.authorizationCodeAuthManager.fetchToken(authorizationCode);
} catch(error) {
// handle error
}
Scopes
Scopes enable your application to only request access to the resources it needs while enabling users to control the amount of access they grant to your application. Available scopes are defined in the OAuthScopeEnum
enumeration.
Scope Name | Description |
---|---|
BoardReadAccess | For reading board |
PinsReadAccess | For reading pins |
BoardsWriteAccess | |
PinsWriteAccess |
Refreshing the token
An access token may expire after sometime. To extend its lifetime, you must refresh the token.
try {
const token = await client.authorizationCodeAuthManager.refreshToken();
} catch(error) {
// handle error
}
If a token expires, an exception will be thrown before the next endpoint call requiring authentication.
Storing an access token for reuse
It is recommended that you store the access token for reuse.
Store the token in session storage or local storage.
Creating a client from a stored token
To authorize a client from a stored access token, just set the access token in Configuration along with the other configuration parameters before creating the client:
const newClient = client.withConfiguration({oAuthToken: token});