urlr-js
v1.2.0
Published
JavaScript client for URLR
Downloads
88
Readme
[email protected]
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: 0.3
- Package version: 1.2.0
- 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 [email protected]
Yarn
yarn install [email protected]
Getting Started
Please follow the installation procedure and then run the following code:
import { Configuration, AuthentificationApi, LinkApi, StatsApi } from "urlr-js"
// Authentification
const authentificationApi = new AuthentificationApi();
authentificationApi.authentification({
authentificationRequest: {
username: '',
password: ''
}
}).then(function (data) {
const configuration = new Configuration({ accessToken: data.token });
// Link shortening
const linkApi = new LinkApi(configuration);
linkApi.reduceLink({
reduceLinkRequest: {
url: '',
team: ''
}
}).then(function (data) {
console.log(data)
}).catch((error) => console.error(error));
}).catch((error) => console.error(error));
A complete example is available here.
API Endpoints
All URIs are relative to https://urlr.me/api
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AuthentificationApi | authentification | POST /login_check | Get an access token FolderApi | folder | GET /folder | Get folders of team LinkApi | reduceLink | POST /reduce-link | Shorten a link StatsApi | stats | POST /stats | Get statistics of a link TeamApi | team | GET /team | Get teams of user
Authorization
bearerAuth
- Type: Bearer authentication (JWT)
Get help / support
Please contact [email protected] and we can take more direct action toward finding a solution.