JavaScript BackEnd SDK

This Node.js SDK lets your application connect to your users' SVGator projects, after they authorized the access using the Frontend SDK. Please note that SVGator strongly recommends the usage of the Backend SDK over direct API calls.

Before You Start

In order to use SVGator's API & SDKs, one first must obtain an SVGator Application. To do so, please email [email protected], providing your SVGator account ID and the desired usage of your SVGator application.

The API keys one should receive from [email protected] are shown below:

| Name | Description | Notes | Sample Value | |------|------|------------|----------| | app_id | Application ID |prefixed with "ai_", followed by 32 alphanumeric chars|ai_b1357de7kj1j3ljd80aadz1eje782f2k| | secret_key | Secret Key |prefixed with "sk_", followed by 32 alphanumeric chars|sk_58ijx87f45596ylv5jeb1a5vicdd92i4|

Creating an application on the fly is also possible using appId=dynamic, yet this feature comes with restrictions. For a multi-user implementation follow the steps above instead.

Requirements

• nodejs >= 7.6

Installation

Run the following command in the directory where you want to install the module

npm i @svgator/sdk-backend

Usage

const SVGatorBackend  = require("@svgator/sdk-backend");
// You may also import our module by:
// import SVGatorBackend from "@svgator/sdk-backend";

let auth_code = 'ac_...';
let app_id = 'ai_...';
let secret_key = 'sk_...';
            
async function run(){

    let svgator = new SVGatorBackend({app_id, secret_key});

    // obtain an access_token based on the auth_code received on front-end
    let {access_token, customer_id} = await svgator.token.get(auth_code);

    // read all SVG projects for a user. limit & offset arguments are optional
    let limit = 1000;
    let offset = 0;
    let {projects} = await svgator.projects.getAll(access_token, customer_id, limit, offset);

    let project_id = projects[0].id;

    // read a single SVG project based on ID
    let {project} = await svgator.projects.get(access_token, project_id);

    // obtain the animated SVG from SVGator
    return svgator.projects.export(access_token, project.id);
}

// output the first animated SVG from the user's account
run()
.then((svg)=>console.log(svg))
.finally(()=>process.exit());