Apideck.Vault

Class Name

VaultApi

Methods

List Connection Custom Mappings
Get Resource Settings
Update Settings
Get All Connections
Deletes A Connection
Import Connection
Get Connection
Authorize Access Token
Update Connection
Consumer Request Counts
Create Consumer
Get All Consumers
Delete Consumer
Get Consumer
Update Consumer
Create Callback State
Get Resource Custom Fields
List Custom Mappings
Get All Consumer Request Logs
Create Session
Validate Connection State

List Connection Custom Mappings

Method: connectionCustomMappingsAll

Apideck->getVaultApi()->connectionCustomMappingsAll($data)

Parameters

Name	Type	Description
unified_api	string	Unified API
service_id	string	Service ID of the resource to return
resource	string	Name of the resource (plural)
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
resource_id	string	This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id.

Response Type

\Apideck\Client\Model\GetCustomMappingsResponse

HTTP response details

Status code	Description
200	Custom mapping
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->connectionCustomMappingsAll('crm', 'pipedrive', 'leads');
  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]

Get Resource Settings

Method: connectionSettingsAll

Apideck->getVaultApi()->connectionSettingsAll($data)

Parameters

Name	Type	Description
unified_api	string	Unified API
service_id	string	Service ID of the resource to return
resource	string	Name of the resource (plural)
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application

Response Type

\Apideck\Client\Model\GetConnectionResponse

HTTP response details

Status code	Description
200	Connection
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->connectionSettingsAll('crm', 'pipedrive', 'leads');
  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]

Update Settings

Method: connectionSettingsUpdate

Apideck->getVaultApi()->connectionSettingsUpdate($data)

Parameters

Name	Type	Description
service_id	string	Service ID of the resource to return
unified_api	string	Unified API
resource	string	Name of the resource (plural)
connection	\Apideck\Client\Model\Connection	Fields that need to be updated on the resource
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application

Response Type

\Apideck\Client\Model\UpdateConnectionResponse

HTTP response details

Status code	Description
200	Connection updated
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->connectionSettingsUpdate('pipedrive', 'crm', 'leads', $connection);
  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]

Get All Connections

Method: connectionsAll

Apideck->getVaultApi()->connectionsAll($data)

Parameters

Name	Type	Description
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
api	string	Scope results to Unified API
configured	bool	Scopes results to connections that have been configured or not

Response Type

\Apideck\Client\Model\GetConnectionsResponse

HTTP response details

Status code	Description
200	Connections
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->connectionsAll();
  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]

Deletes A Connection

Method: connectionsDelete

Apideck->getVaultApi()->connectionsDelete($data)

Parameters

Name	Type	Description
service_id	string	Service ID of the resource to return
unified_api	string	Unified API
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application

Response Type

void (empty response body)

HTTP response details

Status code	Description
204	Resource deleted
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->connectionsDelete('pipedrive', 'crm');
  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]

Import Connection

Method: connectionsImport

Apideck->getVaultApi()->connectionsImport($data)

Parameters

Name	Type	Description
service_id	string	Service ID of the resource to return
unified_api	string	Unified API
connection_import_data	\Apideck\Client\Model\ConnectionImportData	Fields that need to be persisted on the resource
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application

Response Type

\Apideck\Client\Model\CreateConnectionResponse

HTTP response details

Status code	Description
200	Connection created
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->connectionsImport('pipedrive', 'crm', $connection);
  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]

Get Connection

Method: connectionsOne

Apideck->getVaultApi()->connectionsOne($data)

Parameters

Name	Type	Description
service_id	string	Service ID of the resource to return
unified_api	string	Unified API
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application

Response Type

\Apideck\Client\Model\GetConnectionResponse

HTTP response details

Status code	Description
200	Connection
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->connectionsOne('pipedrive', 'crm');
  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]

Authorize Access Token

Method: connectionsToken

Apideck->getVaultApi()->connectionsToken($data)

Parameters

Name	Type	Description
service_id	string	Service ID of the resource to return
unified_api	string	Unified API
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
body	object

Response Type

\Apideck\Client\Model\GetConnectionResponse

HTTP response details

Status code	Description
200	Connection
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->connectionsToken('pipedrive', 'crm', $connectionsToken);
  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]

Update Connection

Method: connectionsUpdate

Apideck->getVaultApi()->connectionsUpdate($data)

Parameters

Name	Type	Description
service_id	string	Service ID of the resource to return
unified_api	string	Unified API
connection	\Apideck\Client\Model\Connection	Fields that need to be updated on the resource
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application

Response Type

\Apideck\Client\Model\UpdateConnectionResponse

HTTP response details

Status code	Description
200	Connection updated
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->connectionsUpdate('pipedrive', 'crm', $connection);
  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]

Consumer Request Counts

Method: consumerRequestCountsAll

Apideck->getVaultApi()->consumerRequestCountsAll($data)

Parameters

Name	Type	Description
consumer_id	string	ID of the consumer to return
start_datetime	string	Scopes results to requests that happened after datetime
end_datetime	string	Scopes results to requests that happened before datetime
x_apideck_app_id	string	The ID of your Unify application

Response Type

\Apideck\Client\Model\ConsumerRequestCountsInDateRangeResponse

HTTP response details

Status code	Description
200	Consumers Request Counts within Date Range
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->consumerRequestCountsAll('test_user_id', '2021-05-01T12:00:00.000Z', '2021-05-30T12:00:00.000Z');
  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]

Create Consumer

Method: consumersAdd

Apideck->getVaultApi()->consumersAdd($data)

Parameters

Name	Type	Description	Notes
consumer	\Apideck\Client\Model\Consumer
x_apideck_app_id	string	The ID of your Unify application

Response Type

\Apideck\Client\Model\CreateConsumerResponse

HTTP response details

Status code	Description
200	Consumer created
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->consumersAdd($consumer);
  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]

Get All Consumers

Method: consumersAll

Apideck->getVaultApi()->consumersAll($data)

Parameters

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.
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetConsumersResponse

HTTP response details

Status code	Description
200	Consumers
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->consumersAll();
  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]

Delete Consumer

Method: consumersDelete

Apideck->getVaultApi()->consumersDelete($data)

Parameters

Name	Type	Description	Notes
consumer_id	string	ID of the consumer to return
x_apideck_app_id	string	The ID of your Unify application

Response Type

\Apideck\Client\Model\DeleteConsumerResponse

HTTP response details

Status code	Description
200	Consumer deleted
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->consumersDelete('test_user_id');
  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]

Get Consumer

Method: consumersOne

Apideck->getVaultApi()->consumersOne($data)

Parameters

Name	Type	Description	Notes
consumer_id	string	ID of the consumer to return
x_apideck_app_id	string	The ID of your Unify application

Response Type

\Apideck\Client\Model\GetConsumerResponse

HTTP response details

Status code	Description
200	Consumer
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->consumersOne('test_user_id');
  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]

Update Consumer

Method: consumersUpdate

Apideck->getVaultApi()->consumersUpdate($data)

Parameters

Name	Type	Description
consumer_id	string	ID of the consumer to return
update_consumer_request	\Apideck\Client\Model\UpdateConsumerRequest
x_apideck_app_id	string	The ID of your Unify application

Response Type

\Apideck\Client\Model\UpdateConsumerResponse

HTTP response details

Status code	Description
200	Consumer updated
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->consumersUpdate('test_user_id', $consumer);
  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]

Create Callback State

Method: createCallbackState

Apideck->getVaultApi()->createCallbackState($data)

Parameters

Name	Type	Description
service_id	string	Service ID of the resource to return
unified_api	string	Unified API
create_callback_state_data	\Apideck\Client\Model\CreateCallbackStateData	Callback state data
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application

Response Type

\Apideck\Client\Model\CreateCallbackStateResponse

HTTP response details

Status code	Description
200	Callback state created
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->createCallbackState('pipedrive', 'crm', $createCallbackState);
  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]

Get Resource Custom Fields

Method: customFieldsAll

Apideck->getVaultApi()->customFieldsAll($data)

Parameters

Name	Type	Description
unified_api	string	Unified API
service_id	string	Service ID of the resource to return
resource	string	Name of the resource (plural)
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
resource_id	string	This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id.

Response Type

\Apideck\Client\Model\GetCustomFieldsResponse

HTTP response details

Status code	Description
200	Custom mapping
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->customFieldsAll('crm', 'pipedrive', 'leads');
  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]

List Custom Mappings

Method: customMappingsAll

Apideck->getVaultApi()->customMappingsAll($data)

Parameters

Name	Type	Description
unified_api	string	Unified API
service_id	string	Service ID of the resource to return
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application

Response Type

\Apideck\Client\Model\GetCustomMappingsResponse

HTTP response details

Status code	Description
200	Custom mapping
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->customMappingsAll('crm', 'pipedrive');
  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]

Get All Consumer Request Logs

Method: logsAll

Apideck->getVaultApi()->logsAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_app_id	string	The ID of your Unify application
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
filter	\Apideck\Client\Model\LogsFilter	Filter results
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetLogsResponse

HTTP response details

Status code	Description
200	Logs
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->logsAll();
  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]

Create Session

Method: sessionsCreate

Apideck->getVaultApi()->sessionsCreate($data)

Parameters

Name	Type	Description
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
session	\Apideck\Client\Model\Session	Additional redirect uri and/or consumer metadata

Response Type

\Apideck\Client\Model\CreateSessionResponse

HTTP response details

Status code	Description
200	Session created
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->sessionsCreate($session);
  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]

Validate Connection State

Method: validateConnectionState

Apideck->getVaultApi()->validateConnectionState($data)

Parameters

Name	Type	Description
service_id	string	Service ID of the resource to return
unified_api	string	Unified API
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
body	object

Response Type

\Apideck\Client\Model\ValidateConnectionStateResponse

HTTP response details

Status code	Description
200	Connection access token refreshed
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?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->getVaultApi()->validateConnectionState('pipedrive', 'crm', $validateConnectionState);
  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]

Files

VaultApi.md

Latest commit

History

VaultApi.md

File metadata and controls

Apideck.Vault

Class Name

Methods

List Connection Custom Mappings

Parameters

Response Type

HTTP response details

Example Usage

Get Resource Settings

Parameters

Response Type

HTTP response details

Example Usage

Update Settings

Parameters

Response Type

HTTP response details

Example Usage

Get All Connections

Parameters

Response Type

HTTP response details

Example Usage

Deletes A Connection

Parameters

Response Type

HTTP response details

Example Usage

Import Connection

Parameters

Response Type

HTTP response details

Example Usage

Get Connection

Parameters

Response Type

HTTP response details

Example Usage

Authorize Access Token

Parameters

Response Type

HTTP response details

Example Usage

Update Connection

Parameters

Response Type

HTTP response details

Example Usage

Consumer Request Counts

Parameters

Response Type

HTTP response details

Example Usage

Create Consumer

Parameters

Response Type

HTTP response details

Example Usage

Get All Consumers

Parameters

Response Type

HTTP response details

Example Usage

Delete Consumer

Parameters

Response Type

HTTP response details

Example Usage

Get Consumer

Parameters

Response Type

HTTP response details

Example Usage

Update Consumer