OtherApi.md

Swagger\Client\OtherApi

All URIs are relative to https://openapi.etsy.com

Method	HTTP request	Description
ping	GET /v3/application/openapi-ping
tokenScopes	POST /v3/application/scopes

ping

\Swagger\Client\Model\Pong ping()

General ReleaseReport bug

This endpoint is ready for production use.

Check to confirm connectivity to the Etsy API with an application

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$apiInstance = new Swagger\Client\Api\OtherApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\Pong

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tokenScopes

\Swagger\Client\Model\Scopes tokenScopes($token)

General ReleaseReport bug

This endpoint is ready for production use.

Check the scopes of the provided token

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$apiInstance = new Swagger\Client\Api\OtherApi(
    // 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
);
$token = "token_example"; // string | 

try {
    $result = $apiInstance->tokenScopes($token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OtherApi->tokenScopes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
token	string		[optional]

Return type

\Swagger\Client\Model\Scopes

Authorization

api_key

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]