Module fungenerators.barcode
ballerinax/fungenerators.barcode Ballerina library
Overview
This is a generated connector for fungenerators BarCode API v1.5 OpenAPI specification.
The fungenerators.barcode API provides capability to generate Barcode images for a given barcode number. You can decode Barcode images and get the barcodes in a numberic form as well. Many industry standard barcode types are supported. The best and complete Barcode API on the cloud.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create an fungenerators account
- Obtain tokens
- Follow this link to obtain tokens
Clients
fungenerators.barcode: Client
This is a generated connector for fungenerators BarCode API v1 OpenAPI specification. The fungenerators.barcode API provides capability to generate Barcode images for a given barcode number. You can decode Barcode images and get the barcodes in a numberic form as well. Many industry standard barcode types are supported. The best and complete Barcode API on the cloud.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create a fungenerators account and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.fungenerators.com" - URL of the target service
getSupportedTypesForEncode
function getSupportedTypesForEncode() returns json|errorGet the supported barcode types for encoding / image generation.
Return Type
- json|error - 200 response
encode
function encode(string number, string? barcodeformat, string? outputformat, int? widthfactor, int? totalheight) returns json|errorGet a Bar Code image for the given barcode number
Parameters
- number string - Barcode number
- barcodeformat string? (default ()) - Barcode format default C39. Valid values are the keys to those returned from /barcode/encode/types.
- outputformat string? (default ()) - Output image format. Must be one of png/html/jpg/svg
- widthfactor int? (default ()) - Width factor of the image
- totalheight int? (default ()) - Total height of the image
Return Type
- json|error - 200 response
getSupportedTypesForDecode
function getSupportedTypesForDecode() returns json|errorGet the supported barcode types for the decoding process.
Return Type
- json|error - 200 response
decode
function decode(BarcodeDecodeBody payload) returns json|errorDecode a Barcode image and return the cotents if successful
Parameters
- payload BarcodeDecodeBody - Request body detail
Return Type
- json|error - 200 response
Records
fungenerators.barcode: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xFungeneratorsApiSecret string - Represents API Key
X-Fungenerators-Api-Secret
fungenerators.barcode: BarcodeDecodeBody
Fields
- barimage string - Barcode image to decode and get the content value
fungenerators.barcode: ClientHttp1Settings
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
- proxy ProxyConfig? - Proxy server related options
fungenerators.barcode: ConnectionConfig
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
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- 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-forwardedheader
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- 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
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
fungenerators.barcode: ProxyConfig
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