https://github.com/limit-zero/marketing-cloud-auth
Salesforce Marketing Cloud REST Authentication Service
https://github.com/limit-zero/marketing-cloud-auth
authentication fuel-sdk marketing-cloud nodejs salesforce
Last synced: 30 days ago
JSON representation
Salesforce Marketing Cloud REST Authentication Service
- Host: GitHub
- URL: https://github.com/limit-zero/marketing-cloud-auth
- Owner: limit-zero
- License: mit
- Created: 2018-10-11T01:21:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-06-25T04:41:19.000Z (almost 4 years ago)
- Last Synced: 2026-05-01T02:10:00.636Z (about 2 months ago)
- Topics: authentication, fuel-sdk, marketing-cloud, nodejs, salesforce
- Language: JavaScript
- Size: 168 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Salesforce Marketing Cloud (Fuel) Authentication
Authenticates and retrieves an access token for the Salesforce Marketing Cloud API. The token can be used for either the REST or SOAP API.
## Features
- Simple
- Lightweight
- Modern: utilizes ES6, Promises via `async/await`, Object rest spread, and `node-fetch`
- As such, _Node 8.6 or higher_ is required.
## Install
Install with [Yarn](https://yarnpkg.com)
```
yarn add marketing-cloud-auth
```
## Usage
To retrieve an access token, require the class and provide your API client ID and secret.
```js
// your-file.js
const MarketingCloudAuth = require('marketing-cloud-auth');
// Instantiate the `MarketingCloudAuth` class
const auth = new MarketingCloudAuth({
clientId: 'your-client-id',
clientSecret: 'your-client-secret',
});
// Retrieve an access token using async/await...
const retrieve = async () => {
const token = await auth.retrieve();
console.log(token);
// Will output somthing similar to
// { value: 'your-token', expiresIn: 3479 }
}
retrieve();
// Or directly with a promise...
auth.retrieve().then(token => console.log(token));
```
Subsequent calls to `auth.retrieve` will _not_ make additional HTTP requests unless the token has expired or you explicitally force a new call via `auth.retrieve({ force: true })`.
Once the token is retrieved, you can include it in your REST API calls:
```http
GET https://www.exacttargetapis.com/platform/v1/endpoints
Accept: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN
```
Or your SOAP calls
```xml
YOUR_ACCESS_TOKEN
YOUR_ACCESS_TOKEN
[...]
```
For more information, see
- https://developer.salesforce.com/docs/atlas.en-us.noversion.mc-apis.meta/mc-apis/authenticate-soap-api.htm
- https://developer.salesforce.com/docs/atlas.en-us.mc-getting-started.meta/mc-getting-started/get-access-token.htm