wikitude_client

v3.0.0

Published

3 years ago

The_Wikitude_Studio_API_is_a_RESTful_API_which_is_used_to_organize_and_manipulate_projects_and_its_targets_create_wtcwto_files_which_can_be_used_to_create_trackers_in_the_Wikitude_SDK_with_the_JavaScript_API_generatepublish_a_cloud_archive_to_the_cloud_re

Downloads

161

0High
0Medium
0Low

yonchev

wikitude client nodejs javascript

wikitude_studio_api_client

WikitudeStudioApiClient - JavaScript client for wikitude_studio_api_client The Wikitude Studio API is a RESTful API which is used to * organize and manipulate projects and its targets * create wtc/wto files which can be used to create trackers in the Wikitude SDK with the JavaScript API * generate/publish a cloud archive to the cloud recognition service (image targets only) Download API clients: * OpenAPI 3.0 * JavaScript * Python * PHP * TypeScript (NodeJS) * Java * Ruby This technical reference formally explains various API endpoints. Visit the Studio API documentation for a more general description. This SDK is automatically generated by the OpenAPI Generator project:

API version: 3.0.0
Package version: 3.0.0
Build package: org.openapitools.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 wikitude_studio_api_client --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 wikitude_studio_api_client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('wikitude_studio_api_client') 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 WikitudeStudioApiClient = require('wikitude_studio_api_client');

var api = new WikitudeStudioApiClient.AccountApi()
var xVersion = "xVersion_example"; // {String} The version of the API to be used. Must be set to 3.
var xToken = "xToken_example"; // {String} Your Manager Token.
api.getAccount(xVersion, xToken).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-eu.wikitude.com/cloudrecognition

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- WikitudeStudioApiClient.AccountApi | getAccount | GET /account | Get account information WikitudeStudioApiClient.HeatmapApi | generateHeatmap | POST /heatmap | Generate Heatmap WikitudeStudioApiClient.HeatmapApi | getHeatmapStatus | GET /heatmap/{generationId} | Status - Generate Heatmap WikitudeStudioApiClient.ImageTargetApi | createImageTargets | POST /targetCollection/{tcId}/targets | Create Image Targets WikitudeStudioApiClient.ImageTargetApi | deleteImageTarget | DELETE /targetCollection/{tcId}/target/{targetId} | Delete Image Target WikitudeStudioApiClient.ImageTargetApi | getImageTarget | GET /targetCollection/{tcId}/target/{targetId} | Get Image Target WikitudeStudioApiClient.ImageTargetApi | getImageTargetStatus | GET /targetCollection/{tcId}/generation/targets/{generationId} | Status - Image Targets Creation WikitudeStudioApiClient.ImageTargetApi | getImageTargets | GET /targetCollection/{tcId}/target | Get Image Targets WikitudeStudioApiClient.ImageTargetApi | updateImageTarget | POST /targetCollection/{tcId}/target/{targetId} | Update Image Target WikitudeStudioApiClient.ImageTargetCollectionApi | createImageTargetCollection | POST /targetCollection | Create Image Target Collection WikitudeStudioApiClient.ImageTargetCollectionApi | deleteImageTargetCollection | DELETE /targetCollection/{tcId} | Delete Image Target Collection WikitudeStudioApiClient.ImageTargetCollectionApi | generateCloudArchive | POST /targetCollection/{tcId}/generation/cloudarchive | Generate Cloud Archive WikitudeStudioApiClient.ImageTargetCollectionApi | generateWTC | POST /targetCollection/{tcId}/generation/wtc | Generate WTC WikitudeStudioApiClient.ImageTargetCollectionApi | getCloudArchiveStatus | GET /targetCollection/{tcId}/generation/cloudarchive/{generationId} | Status - Generate Cloud Archive WikitudeStudioApiClient.ImageTargetCollectionApi | getImageTargetCollection | GET /targetCollection/{tcId} | Get Image Target Collection WikitudeStudioApiClient.ImageTargetCollectionApi | getImageTargetCollections | GET /targetCollection | Get all Image Target Collections WikitudeStudioApiClient.ImageTargetCollectionApi | getSimilarityCheckStatus | GET /targetCollection/{tcId}/similarity/{generationId} | Status - Similarity Check WikitudeStudioApiClient.ImageTargetCollectionApi | getWTCStatus | GET /targetCollection/{tcId}/generation/wtc/{generationId} | Status - Generate WTC WikitudeStudioApiClient.ImageTargetCollectionApi | similarityCheck | POST /targetCollection/{tcId}/similarity | Similarity Check WikitudeStudioApiClient.ImageTargetCollectionApi | updateImageTargetCollection | POST /targetCollection/{tcId} | Update Image Target Collection WikitudeStudioApiClient.ObjectTargetApi | createObjectTargetFromImages | POST /objectTargetCollection/{tcId}/target/images | Create Object Target from Images WikitudeStudioApiClient.ObjectTargetApi | createObjectTargetFromWTO | POST /objectTargetCollection/{tcId}/target/wto | Create Object Target from WTO WikitudeStudioApiClient.ObjectTargetApi | deleteObjectTarget | DELETE /objectTargetCollection/{tcId}/target/{targetId} | Delete Object Target WikitudeStudioApiClient.ObjectTargetApi | extendObjectTarget | PUT /objectTargetCollection/{tcId}/target/{targetId} | Extend Object Target WikitudeStudioApiClient.ObjectTargetApi | getObjectTarget | GET /objectTargetCollection/{tcId}/target/{targetId} | Get Object Target WikitudeStudioApiClient.ObjectTargetApi | getObjectTargetStatus | GET /objectTargetCollection/{tcId}/generation/targets/{generationId} | Status - Object Target Generation Information WikitudeStudioApiClient.ObjectTargetApi | getObjectTargets | GET /objectTargetCollection/{tcId}/target | Get Object Targets WikitudeStudioApiClient.ObjectTargetApi | renameObjectTarget | PUT /objectTargetCollection/{tcId}/target/{targetId}/name | Rename Object Target WikitudeStudioApiClient.ObjectTargetCollectionApi | createObjectTargetCollection | POST /objectTargetCollection | Create Object Target Collection WikitudeStudioApiClient.ObjectTargetCollectionApi | deleteObjectTargetCollection | DELETE /objectTargetCollection/{tcId} | Delete Object Target Collection WikitudeStudioApiClient.ObjectTargetCollectionApi | generateWTO | POST /objectTargetCollection/{tcId}/generation/wto | Generate WTO WikitudeStudioApiClient.ObjectTargetCollectionApi | getObjectTargetCollection | GET /objectTargetCollection/{tcId} | Get Object Target Collection WikitudeStudioApiClient.ObjectTargetCollectionApi | getObjectTargetCollectionStatus | GET /objectTargetCollection/{tcId}/jobs | Status - Get Object Target Collection jobs WikitudeStudioApiClient.ObjectTargetCollectionApi | getObjectTargetCollections | GET /objectTargetCollection | Get all Object Target Collections WikitudeStudioApiClient.ObjectTargetCollectionApi | getWTOStatus | GET /objectTargetCollection/{tcId}/generation/wto/{generationId} | Status - Generate WTO WikitudeStudioApiClient.ObjectTargetCollectionApi | updateObjectTargetCollection | PUT /objectTargetCollection/{tcId} | Update Object Target Collection WikitudeStudioApiClient.ProjectApi | getProjects | GET /projects | Get all projects

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme