ompldr-client-js

omploader

Omploader - JavaScript client for omploader

Take control of your data with Omploader. Omploader is a privacy-first file hosting service that does not compromise on security, privacy, or speed. With Omploader, you pay upfront using Bitcoin, and your file is automatically distributed across a global CDN. You decide how much you want to pay based on usage, and you can refresh at any time. Data is stored using super secure encryption methods (AES-128 on the server, Salsa20 on the client). Furthermore, Omploader does not retain any logs, identifying information, or private keys for file data to respect your privacy. ### About the API The Omploader API is available for public use, and operates under an upfront payment model. Generally speaking, there are no limitations on use, however we retain the right to remove content which may be in violation of the underlying host policies. All API endpoints are rate limited and clients may be throttled as needed. The API returns status code 429 in the event of too many requests.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.0.0
• Package version: 2.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install omploader --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your omploader from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('omploader') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Omploader = require('omploader');
 
var api = new Omploader.DefaultApi()
 
var id = "id_example"; // {String} ID of file to fetch
 
 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getEncryptedFile(id, callback);
 

Documentation for API Endpoints

All URIs are relative to https://api.ompldr.org/v2

Class	Method	HTTP request	Description
Omploader.DefaultApi	getEncryptedFile	GET /get/{id}	Get encrypted file data
Omploader.DefaultApi	getFile	GET /get/{id}/{privateKey}	Get file
Omploader.DefaultApi	getInfo	GET /info/{id}	Get file info
Omploader.DefaultApi	getQuote	POST /quote	Get price quote
Omploader.DefaultApi	pingGet	GET /ping	Health check
Omploader.DefaultApi	refreshFile	PUT /refresh/{id}	Refresh file
Omploader.DefaultApi	uploadFile	POST /upload	Upload file

Documentation for Models

• Omploader.FileInfo
• Omploader.Invoice
• Omploader.Quote
• Omploader.QuoteRequest
• Omploader.RefreshRequest
• Omploader.Response

Documentation for Authorization

All endpoints do not require authorization.