F19 SDK JS

Javascript SDK for the F19 digital reporting platform.

Getting Started

How to install

Installing

A step by step series of examples that tell you how to get a development env running

npm install @happy-horizon/f19-sdk-js

⚠️ This SDK uses the Fetch API under the hood. If your environment doesn't support it, you need to install a polyfill like isomorphic-fetch or node-fetch

Usage

Import the package using ES6 imports or CommonJS require

import F19 from "@happy-horizon/f19-sdk-js";

const F19 = require("@happy-horizon/f19-sdk-js");

Create a new instance of the F19 class with your API key, Client Id, and base URL

const client = new F19({
    apiKey: "[F19_API_KEY]",
    clientId: "[F19_CLIENT_ID]",
    baseUrl: "[F19_BASE_URL]"
});

Now you can access all anonymous methods using the client object.

If you want to access the personal methods, you need to log in first. You can do this by redirecting the user to the F19 login page and then redirecting them back after logging in using a callback URL.

// Define the callback URL (you would replace this with your actual callback URL)
const loginUrl = client.getAuthUrl("https://your.callback.url");

After the user has logged in, they will be redirected back to your callback URL with impersonation options in the request body. You can use these impersonation options to create a new instance of the client that can access the personal methods.

const client = new F19(
    {
        apiKey: "[F19_API_KEY]",
        clientId: "[F19_CLIENT_ID]",
        baseUrl: "[F19_BASE_URL]"
    },
    {
        userId: body.UserId,
        keyThumbprint: body.KeyThumbprint,
        cacheDifferentiator: body.CacheDifferentiator,
        authorizationToken: body.AuthorizationToken
    }
);

Available methods

| Grouping | Method Name | Parameters | | ---------------- | ----------------- | --------------------------------------- | | articles | getAllByProjectId | projectId: string | | | getById | articleId: string | | assets | getImageByName | projectId: string, name: string | | | getDownloadByName | projectId: string, name: string | | | getBlobByToken | token: string | | channel | getAll | | | charts | getAll | projectId: string | | | getById | chartId: string | | downloads | getById | id: string | | | getAllByProjectId | projectId: string | | facetNavigations | getAll | projectId: string | | | getById | facetId: string | | images | getAll | projectId: string | | | getById | imageId: string | | nonce | getNonce | | | projects | getAll | | | | getById | id: string | | reports | getById | id: string | | | getAllByProjectId | id: string | | tables | getAll | projectId: string | | | getById | tableId: string | | tokens | tokenRequest | url: string, authorizationToken: string | | | getPersonal | authorizationToken: string | | | getAnonymous | authorizationToken: string | | websites | getAll | | | | getByAlias | alias: string | | | getCurrent | |

Example usage

// Define the projectId (you would replace this with your actual project ID)
const projectId = "your_project_id_here";

// Call the getAllByProjectId method
client.article
    .getAllByProjectId(projectId)
    .then(result => {
        // Handle the result here
        console.log("Result:", result);
    })
    .catch(error => {
        // Handle any errors that occur
        console.error("Error:", error);
    });