← Back to Home

API Reference

Complete API documentation for developers

Introduction

The PoligonVR Plugin Manager API allows developers to interact with the plugin system programmatically. This API provides endpoints for managing plugins, retrieving information, and configuring settings.

Base URL

https://api.poligonvr.com/v1

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY

Endpoints

GET /plugins

Retrieve a list of all available plugins.

Response

{ "plugins": [ { "id": "plugin-123", "name": "Avatar Optimizer Pro", "version": "1.2.0", "description": "Optimize avatar performance", "category": "Performance", "downloads": 3800, "rating": 4.2 } ], "total": 150, "page": 1 }
GET /plugins/{id}

Get detailed information about a specific plugin.

POST /plugins/{id}/install

Install a plugin.

DELETE /plugins/{id}/uninstall

Uninstall a plugin.

GET /plugins/installed

Get list of installed plugins.

PUT /plugins/{id}/update

Update a plugin to the latest version.

Request Parameters

Parameter Type Required Description
page integer No Page number for pagination (default: 1)
limit integer No Number of results per page (default: 20, max: 100)
category string No Filter by plugin category
search string No Search query for plugin names

Response Codes

Code Description
200 Success
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid or missing API key
404 Not Found - Resource not found
500 Internal Server Error

SDK Examples

JavaScript

const api = new PoligonVRAPI('YOUR_API_KEY'); // Get all plugins const plugins = await api.getPlugins(); // Install a plugin await api.installPlugin('plugin-123'); // Get installed plugins const installed = await api.getInstalledPlugins();

Python

from poligonvr import API api = API('YOUR_API_KEY') # Get all plugins plugins = api.get_plugins() # Install a plugin api.install_plugin('plugin-123') # Get installed plugins installed = api.get_installed_plugins()

Rate Limiting

API requests are rate-limited to ensure fair usage:

Rate limit information is included in response headers:

X-RateLimit-Limit: 100 X-RateLimit-Remaining: 95 X-RateLimit-Reset: 1640995200