Skip to content

Short-io/client-node

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 { setApiKey } from "@short.io/client-node";

setApiKey("YOUR_API_KEY");

Usage

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

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

const domainsResp = await getApiDomains();

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.

About

Node.js client for Short.io website API

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •