urlr-js@3.0.2

TypeScript/JavaScript client for URLR, the GDPR-compliant all-in-one platform for link shortening.

This SDK is automatically generated with the OpenAPI Generator project.

• API version: 2.0.0
• Package version: 3.0.2
• Build package: urlr-js

For more information, please visit https://urlr.me/en

This generator creates TypeScript/JavaScript client that utilizes Fetch API. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript.

Building

To build and compile the TypeScript sources to JavaScript use:

npm install
npm run build

Installation

Navigate to the folder of your project and run one of the following commands:

NPM

npm install urlr-js@3.0.2

Yarn

yarn install urlr-js@3.0.2

Getting Started

Please follow the installation procedure and then run the following code:

import {LinksApi} from "urlr-js"

const apiKey = process.env.URLR_API_KEY; // to be defined on your side

// Access Tokens

let configuration = new Configuration({
  apiKey: apiKey,
});

// Create a link

const linksApi = new LinksApi(configuration);
linksApi.linkCreate({
linkCreateRequest: {
    url: '',
    workspaceId: '',
}
}).then(function (link) {
    console.log(link);
}).catch((error) => console.error(error));

Complete examples can be found in the docs directory of the client repository.

API Endpoints

All URIs are relative to https://urlr.me/api/v2

Class	Method	HTTP request	Description
DomainsApi	domainCreate	POST /domains	Create a domain
DomainsApi	domainGet	GET /domains/{domain_id}	Get a domain
DomainsApi	domainList	GET /domains	List domains
FoldersApi	folderCreate	POST /folders	Create a folder
FoldersApi	folderGet	GET /folders/{folder_id}	Get a folder
FoldersApi	folderList	GET /folders	List folders
LinksApi	linkCreate	POST /links	Create a link
LinksApi	linkDelete	DELETE /links/{link_id}	Delete a link
LinksApi	linkEdit	PATCH /links/{link_id}	Edit a link
LinksApi	linkGet	GET /links/{link_id}	Get a link
LinksApi	linkList	GET /links	List links
QRCodesApi	qrcodeCreate	POST /qrcodes	Create a QR Code
StatisticsApi	statisticGet	GET /statistics	Get statistics
WorkspacesApi	workspaceGet	GET /workspaces/{workspace_id}	Get a workspace
WorkspacesApi	workspaceList	GET /workspaces	List workspaces of user

Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

Get help / support

Please contact contact@urlr.me and we can take more direct action toward finding a solution.