ConnectorApi
- Get API Resource Coverage
- Get API Resource
- List APIs
- Get API
- Get Connector Doc Content
- Get Connector Resource
- List Connectors
- Get Connector
Method: apiResourceCoverageOne
Apideck->getConnectorApi()->apiResourceCoverageOne($data)| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| resource_id | string | ID of the resource you are acting upon. | |
| x_apideck_app_id | string | The ID of your Unify application |
\Apideck\Client\Model\GetApiResourceCoverageResponse
| Status code | Description |
|---|---|
| 200 | ApiResources |
| 401 | Unauthorized |
| 402 | Payment Required |
| 404 | The specified resource was not found |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getConnectorApi()->apiResourceCoverageOne('id_example', 'resource_id_example');
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}[Back to top] [Back to API list] [Back to README]
Method: apiResourcesOne
Apideck->getConnectorApi()->apiResourcesOne($data)| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| resource_id | string | ID of the resource you are acting upon. | |
| x_apideck_app_id | string | The ID of your Unify application |
\Apideck\Client\Model\GetApiResourceResponse
| Status code | Description |
|---|---|
| 200 | ApiResources |
| 401 | Unauthorized |
| 402 | Payment Required |
| 404 | The specified resource was not found |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getConnectorApi()->apiResourcesOne('id_example', 'resource_id_example');
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}[Back to top] [Back to API list] [Back to README]
Method: apisAll
Apideck->getConnectorApi()->apisAll($data)| Name | Type | Description | Notes |
|---|---|---|---|
| x_apideck_app_id | string | The ID of your Unify application | |
| cursor | string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
| filter | \Apideck\Client\Model\ApisFilter | Apply filters | |
| limit | [int] | Number of results to return. Minimum 1, Maximum 200, Default 20 | (optional) defaults to 20 |
\Apideck\Client\Model\GetApisResponse
| Status code | Description |
|---|---|
| 200 | Apis |
| 400 | Bad Request |
| 401 | Unauthorized |
| 402 | Payment Required |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getConnectorApi()->apisAll();
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}[Back to top] [Back to API list] [Back to README]
Method: apisOne
Apideck->getConnectorApi()->apisOne($data)| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| x_apideck_app_id | string | The ID of your Unify application |
\Apideck\Client\Model\GetApiResponse
| Status code | Description |
|---|---|
| 200 | Apis |
| 401 | Unauthorized |
| 402 | Payment Required |
| 404 | The specified resource was not found |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getConnectorApi()->apisOne('id_example');
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}[Back to top] [Back to API list] [Back to README]
Method: connectorDocsOne
Apideck->getConnectorApi()->connectorDocsOne($data)| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| doc_id | string | ID of the Doc | |
| x_apideck_app_id | string | The ID of your Unify application |
string
| Status code | Description |
|---|---|
| 200 | Connectors |
| 401 | Unauthorized |
| 402 | Payment Required |
| 404 | The specified resource was not found |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getConnectorApi()->connectorDocsOne('id_example', 'application_owner+oauth_credentials');
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}[Back to top] [Back to API list] [Back to README]
Method: connectorResourcesOne
Apideck->getConnectorApi()->connectorResourcesOne($data)| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| resource_id | string | ID of the resource you are acting upon. | |
| x_apideck_app_id | string | The ID of your Unify application | |
| unified_api | \Apideck\Client\Model\UnifiedApiId | Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs |
\Apideck\Client\Model\GetConnectorResourceResponse
| Status code | Description |
|---|---|
| 200 | ConnectorResources |
| 401 | Unauthorized |
| 402 | Payment Required |
| 404 | The specified resource was not found |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getConnectorApi()->connectorResourcesOne('id_example', 'resource_id_example');
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}[Back to top] [Back to API list] [Back to README]
Method: connectorsAll
Apideck->getConnectorApi()->connectorsAll($data)| Name | Type | Description | Notes |
|---|---|---|---|
| x_apideck_app_id | string | The ID of your Unify application | |
| cursor | string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
| filter | \Apideck\Client\Model\ConnectorsFilter | Apply filters | |
| limit | [int] | Number of results to return. Minimum 1, Maximum 200, Default 20 | (optional) defaults to 20 |
\Apideck\Client\Model\GetConnectorsResponse
| Status code | Description |
|---|---|
| 200 | Connectors |
| 400 | Bad Request |
| 401 | Unauthorized |
| 402 | Payment Required |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getConnectorApi()->connectorsAll();
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}[Back to top] [Back to API list] [Back to README]
Method: connectorsOne
Apideck->getConnectorApi()->connectorsOne($data)| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the record you are acting upon. | |
| x_apideck_app_id | string | The ID of your Unify application |
\Apideck\Client\Model\GetConnectorResponse
| Status code | Description |
|---|---|
| 200 | Connectors |
| 401 | Unauthorized |
| 402 | Payment Required |
| 404 | The specified resource was not found |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getConnectorApi()->connectorsOne('id_example');
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}