README

The ONLYOFFICE DocSpace SDK for PHP is a library that provides tools for integrating and managing DocSpace features within your applications. It simplifies interaction with the DocSpace API by offering ready-to-use methods and models.

For more information, please visit https://helpdesk.onlyoffice.com/hc/en-us.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/ONLYOFFICE/docspace-api-sdk-php"
    }
  ],
  "require": {
    "onlyoffice/docspace-api-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/onlyoffice/docspace-api-sdk/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure HTTP basic authorization: Basic
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure API key authorization: ApiKeyBearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('ApiKeyBearer', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('ApiKeyBearer', 'Bearer');

// Configure API key authorization: asc_auth_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('asc_auth_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('asc_auth_key', 'Bearer');

// Configure Bearer (JWT) authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');



$apiInstance = new OpenAPI\Client\Api\ApiKeysApi(
    // 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(),
    $config
);
$create_api_key_request_dto = new \OpenAPI\Client\Model\CreateApiKeyRequestDto(); // \OpenAPI\Client\Model\CreateApiKeyRequestDto

try {
    $result = $apiInstance->createApiKey($create_api_key_request_dto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiKeysApi->createApiKey: ', $e->getMessage(), PHP_EOL;
}

Authorization

Authentication schemes defined for the API:

asc_auth_key

• Type: API key
• API key parameter name: asc_auth_key
• Location: Cookie

Basic

• Type: HTTP basic authentication

Bearer

• Type: Bearer authentication (JWT)

ApiKeyBearer

• Type: API key
• API key parameter name: ApiKeyBearer
• Location: HTTP header

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: {{authBaseUrl}}/oauth2/authorize
• Token Url: {{authBaseUrl}}/oauth2/token
• Scopes:
  • read: Read access to protected resources
  • write: Write access to protected resources

OpenId

• Type: OpenId Connect
• OpenId Connect URL: {{authBaseUrl}}/.well-known/openid-configuration

x-signature

• Type: API key
• API key parameter name: x-signature
• Location: Cookie

API Endpoints

All URIs are relative to https://your-docspace.onlyoffice.com

API Endoints tables:

Documentation for Models

Author

support@onlyoffice.com