@uploadcare/api

Uploadcare Javascript API

:bangbang: Work in progress. The API will be changed. Do not use it. Really. :bangbang:

JavaScript library for work with Uploadcare API.

 

• Requirements
• Install
• Usage
• Configuration
• Security issues
• Feedback

Requirements

Install

npm install @uploadcare/api --save

Usage

import {UploadAPI} from '@uploadcare/api'

UploadAPI.request(method, path, {query, body})
UploadAPI.base(file, {publicKey, store})
UploadAPI.fromUrl(url, {publicKey, store, fileName})
UploadAPI.fromUrlStatus(token)
UploadAPI.group([uuids], {publicKey})
UploadAPI.groupInfo(groupId, {publicKey})
UploadAPI.info(uuid, {publicKey})
UploadAPI.multipartStart({publicKey, filename, size})
UploadAPI.multipartUpload(partUrl, data)
UploadAPI.multipartComplete(uuid, {publicKey})

Configuration

Security issues

If you think you ran into something in Uploadcare libraries which might have security implications, please hit us up at [e-mail] or Hackerone.

We'll contact you personally in a short time to fix an issue through co-op and prior to any public disclosure.

Feedback

Issues and PRs are welcome. You can provide your feedback or drop us a support request at [e-mail].

Changelog

1.0.0-alpha

The first public alpha release.

Added

• The request function to request to any path of [Upload API][upload-api].
• Low-level request wrappers for /base/ and /info/ paths of Upload API.
• UploadClient class with settings and fileFrom method that supports only direct uploads now.
• Support of following Uploadcare Settings: publicKey, baseUrl, doNotStore, integration, secureExpire, secureSignature.
• Test environment for both Node.js and browsers