apideck.proxy
Module apideck.proxy
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_apideck.proxy_1.1.1.png)
ballerinax/apideck.proxy Ballerina library
Overview
This is a generated connector from Apideck Proxy API v5.3.0 OpenAPI specification.
You can use this API to access all Proxy API endpoints.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Apideck account
- Obtain tokens by following this guide
Clients![](/images/permalink.svg)
apideck.proxy: Client![](/images/permalink.svg)
This is a generated connector from Apideck Proxy API v5.3.0 OpenAPI specification. You can use this API to access all Proxy API endpoints.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Unify API accounts have sandbox mode and live mode API keys. To change modes just use the appropriate key to get a live or test object.
You can find your API keys on the unify settings of your Apideck app.Your Apideck application_id can also be found on the same page.
Obtain API keys following this guide.
init (ApiKeysConfig apiKeyConfig, ClientConfiguration clientConfig, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://unify.apideck.com" - URL of the target service
getProxy![](/images/permalink.svg)
function getProxy(string xApideckConsumerId, string xApideckAppId, string xApideckServiceId, string xApideckDownstreamUrl, string? xApideckDownstreamAuthorization) returns json|error
GET
Parameters
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- xApideckServiceId string - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- xApideckDownstreamUrl string - Downstream URL
- xApideckDownstreamAuthorization string? (default ()) - Downstream authorization header. This will skip the Vault token injection.
Return Type
- json|error - Ok
putProxy![](/images/permalink.svg)
function putProxy(string xApideckConsumerId, string xApideckAppId, string xApideckServiceId, string xApideckDownstreamUrl, json payload, string? xApideckDownstreamAuthorization) returns json|error
PUT
Parameters
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- xApideckServiceId string - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- xApideckDownstreamUrl string - Downstream URL
- payload json - Depending on the verb/method of the request this will contain the request body you want to POST/PATCH/PUT.
- xApideckDownstreamAuthorization string? (default ()) - Downstream authorization header. This will skip the Vault token injection.
Return Type
- json|error - Ok
postProxy![](/images/permalink.svg)
function postProxy(string xApideckConsumerId, string xApideckAppId, string xApideckServiceId, string xApideckDownstreamUrl, json payload, string? xApideckDownstreamAuthorization) returns json|error
POST
Parameters
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- xApideckServiceId string - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- xApideckDownstreamUrl string - Downstream URL
- payload json - Depending on the verb/method of the request this will contain the request body you want to POST/PATCH/PUT.
- xApideckDownstreamAuthorization string? (default ()) - Downstream authorization header. This will skip the Vault token injection.
Return Type
- json|error - Ok
deleteProxy![](/images/permalink.svg)
function deleteProxy(string xApideckConsumerId, string xApideckAppId, string xApideckServiceId, string xApideckDownstreamUrl, string? xApideckDownstreamAuthorization) returns json|error
DELETE
Parameters
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- xApideckServiceId string - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- xApideckDownstreamUrl string - Downstream URL
- xApideckDownstreamAuthorization string? (default ()) - Downstream authorization header. This will skip the Vault token injection.
Return Type
- json|error - Ok
patchProxy![](/images/permalink.svg)
function patchProxy(string xApideckConsumerId, string xApideckAppId, string xApideckServiceId, string xApideckDownstreamUrl, json payload, string? xApideckDownstreamAuthorization) returns json|error
PATCH
Parameters
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- xApideckServiceId string - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- xApideckDownstreamUrl string - Downstream URL
- payload json - Depending on the verb/method of the request this will contain the request body you want to POST/PATCH/PUT.
- xApideckDownstreamAuthorization string? (default ()) - Downstream authorization header. This will skip the Vault token injection.
Return Type
- json|error - Ok
Records![](/images/permalink.svg)
apideck.proxy: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string - To use API you have to sign up and get your own API key. Unify API accounts have sandbox mode and live mode API keys.
To change modes just use the appropriate key to get a live or test object. You can find your API keys on the unify settings of your Apideck app.
Your Apideck application_id can also be found on the same page.
Authenticate your API requests by including your test or live secret API key in the request header.
- Bearer authorization header:
Authorization: Bearer <your-apideck-api-key>
- Application id header:
x-apideck-app-id: <your-apideck-app-id>
- Bearer authorization header:
apideck.proxy: InlineResponse401![](/images/permalink.svg)
Fields
- detail string? - Contains parameter or domain specific information related to the error and why it occured.
- _error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
- message string? - A human-readable message providing more details about the error.
- ref string? - Link to documentation of error type
- status_code decimal? - HTTP status code
- type_name string? - The type of error returned
Import
import ballerinax/apideck.proxy;
Metadata
Released date: over 2 years ago
Version: 1.1.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: slbeta6
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
IT Operations/Server Monitoring
Cost/Freemium
Contributors
Dependencies