README

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:

This technical reference formally explains various API endpoints. Visit the Studio API documentation for a more general description.

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/wikitude_studio_api_client/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new OpenAPI\Client\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$x_version = 3; // string | The version of the API to be used. Must be set to 3.
$x_token = 'x_token_example'; // string | Your Manager Token.

try {
    $result = $apiInstance->getAccount($x_version, $x_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api-eu.wikitude.com/cloudrecognition

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

Models

Authorization

All endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

upthemedia / wikitude

Maintainers

Details