node-snapchat-marketing

Snapchat Marketing Node.js Wrapper

:ghost: Unoffical nodejs client for the Snapchat Marketing API

Snapchat Marketing API Documentation

Installation

Before you begin, you need to register your app in the Snapchat developer dashboard. Notice that the app gets a client ID, secret, and redirect URI required for authenticating with the API.

After registering your application, you need to install this module in your Node.js project:

npm install node-snapchat-marketing

Initialization

In order to use this module, you have to import it in your application first:

var snap = require('node-snapchat-marketing');

Next, initialize the Snap object with the keys you obtained from the Snapchat business dashboard:

const snap = new Snap({
  client_id: '<CLIENT_ID>',
  client_secret: '<CLIENT_SECRET>',
  redirect_uri: '<REDIRECT_URI>',
});

Authenticating

To make HTTP calls, you need to create an authenticated session with the API.

Step One: Authorize

To obtain an OAuth 2 bearer token, you have to authorize your application with the required scope. The only scope currently available is 'snapchat-marketing-api'.

You are initially required to redirect your user to an authorization URL. You can generate the authorization URL using snap.getAuthorizeUrl. In case you are using Express, your route definition could look as follows:

app.get('/snap/authorize', function(req, res) {
  var url = snap.getAuthorizeUrl('snapchat-marketing-api');
  res.redirect(url);
});

The URL will lead to a page where your user will be required to login and approve access to his/her Snapchat account. In case that step was successful, Snap will issue a redirect to the redirect_uri defined in your Snapchat business account. On that redirect, you will receive a single-use authorization code via a code query parameter in the url.

Step Two: Receive redirect and get an access token

To complete the authorization you now need to receive the callback and convert the given authorization code into an OAuth access token. You can accomplish that using snap.authorization. This method will retrieve and store the access_token, refresh_token, and token expiration date inside the Snap object. Access tokens expire after 1800 seconds (30 minutes).

Using Express, you could achieve that as follows:

app.get('/snap/callback', (req,res)=>{
  snap.authorization({ authorization_code: req.query.code }, function(err, token){
    console.log("Access token is: " + token.access_token);
    console.log("Refresh token is: " + token.access_token);
    console.log("Access token expires in: " + token.expires_in + " seconds");
    res.redirect('/');
  });
});

You can also manually set access/refresh tokens

snap.setAccessToken('<token>'); snap.setRefreshToken('<token>');

Step Three: Make HTTP requests to available resources

Now that you are authenticated, you can issue requests using provided methods.

For instance, to obtain a list of all available organizations associated with your account, you can use snap.organization.getAllOrganizations.

snap.organization.getAllOrganizations(function(err, orgs)
{
  if(err)
    console.log(err);
  else
    console.log(orgs);
});

Library Methods

Authorization

Generate Authorize URL

After getting the authorize url, the user will be redirected to the redirect url with authorization code used in the next function.

snap.getAuthorizeUrl(scope);

Parameter

• Use 'snapchat-marketing-api' as your scope.

Example

app.get('/snap/authorize', function(req, res) {
  var url = snap.getAuthorizeUrl('snapchat-marketing-api');
  res.redirect(url);
});

Retrieve and store a new access token based off of a code

snap.authorization(options, callback);

Parameter

• options (object) - Object with attribute authorization_code OR refresh_token

Example

app.get('/snap/callback', (req,res)=>{
  snap.authorization({ authorization_code : req.query.code }, function(err, token){
    console.log("Access token is: " + accessToken.access_token);
    console.log("Refresh token is: " + accessToken.access_token);
    console.log("Access token expires in: " + accessToken.expires_in + " seconds");
    res.redirect('/');
  });
});

Me

Get authenticated user

snap.me(callback);

Example

snap.me(function(err, user){
  if(err)
    console.log(err);
  else
    console.log(user);
})

Organization

Get all organizations

snap.organization.getAllOrganizations(callback);

Example

snap.organization.getAllOrganizations(function(err, orgs){
  if(err)
    console.log(err);
  else
    console.log(orgs);
});

Get organization by id

snap.organization.getOrganizationById(id, callback);

Example

snap.organization.getOrganizationById('<organization_id>', function(err, org){
  if(err)
    console.log(err);
   else
    console.log(org);
});

Media

Create a new Media

snap.media.createMedia(media, callback);

Parameter

• media (object) - JS object with options describing type of media to create

Example

const newMedia = {
    media: [
      { name:"Some new media", type:"VIDEO", ad_account_id: myAdAccountId },
    ]
  }
  
snap.media.createMedia(newMedia, function(err, res){
  if(err)
    console.log(err);
});

ad_account_id - your Snapchat business account id. Can be found on your Snapchat Business Account

Get all Media associated with the authenticated account

snap.media.getAllMedia(adAccountId, callback);

Parameter

• adAccountId - your Snapchat business account id. Can be found on your Snapchat Business Account

Example

snap.media.getAllMedia(adAccountId, function(err,media)
  {
    if(err)
      console.log(err);
    else
      console.log(media);
  })

Looking for more contributors!