@short.io/client-node

Short.io Node.js SDK

The Short.io Node.js official SDK client is a library that allows you to integrate short.io URL shortening and link management API with your Node.js application in an easy and elegant way. This SDK contains methods for working with links and domains.

API reference

See the API docs for more information.

Installing

To install the SDK, run:

npm i @short.io/client-node

Getting Started

First you need to get your API key from the Short.io dashboard in the Integrations & API section. Then you need to set the configuration for the client:

import { client } from "@short.io/client-node";

client.setConfig({
    baseUrl: "https://api.short.io",
    headers: {
        Authorization: "YOUR_API_KEY",
    },
});

Usage

Import the needed methods from the SDK and use them in your code:

import {
    client,
    getApiDomains,
    getLinksExpand,
    // and other needed methods
} from "@short.io/client-node";

Pass created client to the methods:

const domainsResp = await getApiDomains({ client });

domainsResp.data will contain the list of domains.

const linkResp = await getLinksExpand({
    client,
    query: {
        domain: "your_domain.com",
        path: "lnk_abc123_abcde12345,
    },
});

linkResp.data will contain the expanded link.