SVRFClient - the Swift client library for the SVRF API
For more information, please visit 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 & Usage
CocoaPods
Install frompod 'SVRFClient', '~> 1.5.0'
Recommendation
It's recommended to create an instance of ApiClient per thread in a multi-threaded environment to avoid any potential issues.
Getting Started
Please follow the installation procedure. You can find code example at SVRF ARKitFaceFilterDemo
Documentation for API Endpoints
All URIs are relative to https://api.svrf.com/v1
Class | Method | HTTP request | Description |
---|---|---|---|
AuthenticateAPI | authenticate | POST /app/authenticate | Authenticate application |
MediaAPI | getById | GET /vr/{id} | Media by ID Endpoint |
MediaAPI | getTrending | GET /vr/trending | Trending Endpoint |
MediaAPI | search | GET /vr/search | Search Endpoint |
Documentation For Authorization
XAppToken
- Type: API key
- API key parameter name: x-app-token
- Location: HTTP header