Authenticating to Smooch API

Once you’ve obtained a relevant key and secret pair as described in the JWT documentation, you’re ready to authenticate to the Smooch API and put it to use.

Using a HTTP Request Header

If you’re calling the API directly, you’ll need to craft a token from the key and secret pair as described in the JWT documentation.

The JWT itself is transmitted via the HTTP authorization header. The token should be prefixed with “Bearer” followed by a space. For example: Bearer your-jwt.

# Calling GET /v1/appusers using a jwt
curl \
     -H 'authorization: Bearer your-jwt'

Using the Smooch Core Javascript Library

The easiest way to use the Smooch API is through the Smooch Core Javascript Library. This library conveniently wraps all of the Smooch API in a Javascript-friendly way, helping you get up and running rather quickly.

To authenticate to the API, you need only initialize the library like so:

// Initializing Smooch Core with a jwt in Node.js
var smooch = new SmoochCore({
    keyId: 'your-key-id',
    secret: 'your-secret',
    scope: 'app', // app or appUser, if appUser, you must include a userId parameter

You can also initialize the library to perform operations at the account level (for managed accounts) or at the individual user level. Read more about how to do this in the javascript library documentation

Next Steps