# svrf-client

> SVRF API client

Latest version **1.5.0** (published 2019-03-29) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install svrf-client
pnpm add svrf-client
yarn add svrf-client
bun add svrf-client
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2019-03-29 |
| First published | 2018-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 173.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | svrf-engineering |

## Links

- npm: https://www.npmjs.com/package/svrf-client
- Repository: https://github.com/SVRF/svrf-javascript-client
- Homepage: https://github.com/SVRF/svrf-javascript-client#readme
- Issues: https://github.com/SVRF/svrf-javascript-client/issues
- npm.io page: https://npm.io/package/svrf-client

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) 3.7.0

## Recent versions

- 1.5.0 (latest) — 2019-03-29
- 2.0.0-beta.1 (beta) — 2019-04-08
- 2.0.0-beta — 2019-04-08
- 1.4.0 — 2019-02-28
- 1.3.0 — 2018-10-23
- 1.2.0 — 2018-10-01
- 1.1.1 — 2018-09-24
- 1.1.0 — 2018-08-02
- 1.0.0 — 2018-06-21

## README

# svrf-client - the JavaScript client library for the SVRF API

For more information, please visit [https://github.com/svrf/svrf-api](https://github.com/svrf/svrf-api)

## Getting Started

SVRF's API allows you to supercharge your project or app with the first and largest search engine for immersive experiences. We make it simple for any developer to incorporate highly immersive experiences with all kinds of applications: virtual reality, augmented reality, mixed reality, mobile, and web.

The SVRF API Documentation is available at <https://developers.svrf.com>.

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

Install it via:

```shell
npm install svrf-client --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

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

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var SVRF = require('svrf-client');

var api = new SVRF.AuthenticateApi()

var body = new SVRF.Body(); // {Body} 

api.authenticate(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

All URIs are relative to *https://api.svrf.com/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*SVRF.AuthenticateApi* | [**authenticate**](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/AuthenticateApi.md#authenticate) | **POST** /app/authenticate | Authenticate application
*SVRF.MediaApi* | [**getById**](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/MediaApi.md#getById) | **GET** /vr/{id} | Media by ID Endpoint
*SVRF.MediaApi* | [**getTrending**](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/MediaApi.md#getTrending) | **GET** /vr/trending | Trending Endpoint
*SVRF.MediaApi* | [**search**](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/MediaApi.md#search) | **GET** /vr/search | Search Endpoint


## Documentation for Models

 - [SVRF.APIKey](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/APIKey.md)
 - [SVRF.Body](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/Body.md)
 - [SVRF.Category](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/Category.md)
 - [SVRF.ErrorResponse](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/ErrorResponse.md)
 - [SVRF.Media](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/Media.md)
 - [SVRF.MediaFiles](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/MediaFiles.md)
 - [SVRF.MediaImages](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/MediaImages.md)
 - [SVRF.MediaMetadata](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/MediaMetadata.md)
 - [SVRF.MediaStereo](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/MediaStereo.md)
 - [SVRF.MediaType](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/MediaType.md)
 - [SVRF.MediaVideos](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/MediaVideos.md)
 - [SVRF.StereoscopicType](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/StereoscopicType.md)
 - [SVRF.SuccessResponse](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/SuccessResponse.md)
 - [SVRF.AuthResponse](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/AuthResponse.md)
 - [SVRF.PaginationResponse](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/PaginationResponse.md)
 - [SVRF.RateLimitResponse](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/RateLimitResponse.md)
 - [SVRF.SingleMediaResponse](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/SingleMediaResponse.md)
 - [SVRF.SearchMediaResponse](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/SearchMediaResponse.md)
 - [SVRF.TrendingResponse](https://github.com/SVRF/svrf-javascript-client/blob/master/docs/TrendingResponse.md)


## Documentation for Authorization


### XAppToken

- **Type**: API key
- **API key parameter name**: x-app-token
- **Location**: HTTP header

---
_Source: https://npm.io/package/svrf-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._