Ballerina library

apideck.proxy

Module apideck.proxy

OverviewPrerequisites

API

Client

Definitions

ApiKeysConfig
ClientHttp1Settings
ConnectionConfig
InlineResponse401
ProxyConfig

ballerinax/apideck.proxy Ballerina library

1.5.1

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:

Clients

apideck.proxy: Client

Isolated

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

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, ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig {} - The configurations to be used when initializing the connector
  • serviceUrl string "https://unify.apideck.com" - URL of the target service

getProxy

Isolated FunctionRemote Function
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
  • xApideckDownstreamUrl string - Downstream URL
  • xApideckDownstreamAuthorization string? (default ()) - Downstream authorization header. This will skip the Vault token injection.
Return Type

putProxy

Isolated FunctionRemote Function
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
  • 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

postProxy

Isolated FunctionRemote Function
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
  • 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

deleteProxy

Isolated FunctionRemote Function
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
  • xApideckDownstreamUrl string - Downstream URL
  • xApideckDownstreamAuthorization string? (default ()) - Downstream authorization header. This will skip the Vault token injection.
Return Type

patchProxy

Isolated FunctionRemote Function
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
  • 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

Records

apideck.proxy: ApiKeysConfig

Closed record

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>
    You should use the public keys on the SDKs and the secret keys to authenticate API requests. Do not share or include your secret API keys on client side code. Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub. Learn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key Go to Unify to grab your API KEY https://app.apideck.com/unify/api-keys

apideck.proxy: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

apideck.proxy: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

apideck.proxy: InlineResponse401

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

apideck.proxy: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

Import

import ballerinax/apideck.proxy;Copy

Metadata

Released date: 12 months ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

IT Operations/Server Monitoring

Cost/Freemium

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.1
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC