# cloudmersive_barcode_api_client
Barcode APIs let you generate barcode images, and recognize values from images of barcodes.
This Python package provides a native API client for [Cloudmersive Barcode API](https://www.cloudmersive.com/barcode-api)
- API version: v1
- Package version: 3.1.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import cloudmersive_barcode_api_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import cloudmersive_barcode_api_client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import cloudmersive_barcode_api_client
from cloudmersive_barcode_api_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Apikey
configuration = cloudmersive_barcode_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'
# create an instance of the API class
api_instance = cloudmersive_barcode_api_client.BarcodeLookupApi(cloudmersive_barcode_api_client.ApiClient(configuration))
value = 'value_example' # str | Barcode value
try:
# Lookup EAN barcode value, return product data
api_response = api_instance.barcode_lookup_ean_lookup(value)
pprint(api_response)
except ApiException as e:
print("Exception when calling BarcodeLookupApi->barcode_lookup_ean_lookup: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.cloudmersive.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BarcodeLookupApi* | [**barcode_lookup_ean_lookup**](docs/BarcodeLookupApi.md#barcode_lookup_ean_lookup) | **POST** /barcode/lookup/ean | Lookup EAN barcode value, return product data
*BarcodeScanApi* | [**barcode_scan_image**](docs/BarcodeScanApi.md#barcode_scan_image) | **POST** /barcode/scan/image | Scan and recognize an image of a barcode
*BarcodeScanApi* | [**barcode_scan_image_advanced_qr**](docs/BarcodeScanApi.md#barcode_scan_image_advanced_qr) | **POST** /barcode/scan/image/advanced/qr | Advanced AI scan and recognition of an image of one or more QR barcodes
*GenerateBarcodeApi* | [**generate_barcode_ean13**](docs/GenerateBarcodeApi.md#generate_barcode_ean13) | **POST** /barcode/generate/ean-13 | Generate a EAN-13 code barcode as PNG file
*GenerateBarcodeApi* | [**generate_barcode_ean8**](docs/GenerateBarcodeApi.md#generate_barcode_ean8) | **POST** /barcode/generate/ean-8 | Generate a EAN-8 code barcode as PNG file
*GenerateBarcodeApi* | [**generate_barcode_qr_code**](docs/GenerateBarcodeApi.md#generate_barcode_qr_code) | **POST** /barcode/generate/qrcode | Generate a QR code barcode as PNG file
*GenerateBarcodeApi* | [**generate_barcode_upca**](docs/GenerateBarcodeApi.md#generate_barcode_upca) | **POST** /barcode/generate/upc-a | Generate a UPC-A code barcode as PNG file
*GenerateBarcodeApi* | [**generate_barcode_upce**](docs/GenerateBarcodeApi.md#generate_barcode_upce) | **POST** /barcode/generate/upc-e | Generate a UPC-E code barcode as PNG file
## Documentation For Models
- [BarcodeLookupResponse](docs/BarcodeLookupResponse.md)
- [BarcodeQRResultItem](docs/BarcodeQRResultItem.md)
- [BarcodeScanQRAdvancedResult](docs/BarcodeScanQRAdvancedResult.md)
- [BarcodeScanResult](docs/BarcodeScanResult.md)
- [ProductMatch](docs/ProductMatch.md)
## Documentation For Authorization
## Apikey
- **Type**: API key
- **API key parameter name**: Apikey
- **Location**: HTTP header
## Author
Raw data
{
"_id": null,
"home_page": "https://www.cloudmersive.com/barcode-api",
"name": "cloudmersive-barcode-api-client",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Swagger, barcodeapi",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/32/cb/1b87e05c98cb2cb238e8649fc8225feeae99b10eeae43afc896201de35aa/cloudmersive_barcode_api_client-3.1.0.tar.gz",
"platform": null,
"description": "# cloudmersive_barcode_api_client\nBarcode APIs let you generate barcode images, and recognize values from images of barcodes.\n\nThis Python package provides a native API client for [Cloudmersive Barcode API](https://www.cloudmersive.com/barcode-api)\n\n- API version: v1\n- Package version: 3.1.0\n- Build package: io.swagger.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport cloudmersive_barcode_api_client \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport cloudmersive_barcode_api_client\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport cloudmersive_barcode_api_client\nfrom cloudmersive_barcode_api_client.rest import ApiException\nfrom pprint import pprint\n\n# Configure API key authorization: Apikey\nconfiguration = cloudmersive_barcode_api_client.Configuration()\nconfiguration.api_key['Apikey'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['Apikey'] = 'Bearer'\n\n# create an instance of the API class\napi_instance = cloudmersive_barcode_api_client.BarcodeLookupApi(cloudmersive_barcode_api_client.ApiClient(configuration))\nvalue = 'value_example' # str | Barcode value\n\ntry:\n # Lookup EAN barcode value, return product data\n api_response = api_instance.barcode_lookup_ean_lookup(value)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling BarcodeLookupApi->barcode_lookup_ean_lookup: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.cloudmersive.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BarcodeLookupApi* | [**barcode_lookup_ean_lookup**](docs/BarcodeLookupApi.md#barcode_lookup_ean_lookup) | **POST** /barcode/lookup/ean | Lookup EAN barcode value, return product data\n*BarcodeScanApi* | [**barcode_scan_image**](docs/BarcodeScanApi.md#barcode_scan_image) | **POST** /barcode/scan/image | Scan and recognize an image of a barcode\n*BarcodeScanApi* | [**barcode_scan_image_advanced_qr**](docs/BarcodeScanApi.md#barcode_scan_image_advanced_qr) | **POST** /barcode/scan/image/advanced/qr | Advanced AI scan and recognition of an image of one or more QR barcodes\n*GenerateBarcodeApi* | [**generate_barcode_ean13**](docs/GenerateBarcodeApi.md#generate_barcode_ean13) | **POST** /barcode/generate/ean-13 | Generate a EAN-13 code barcode as PNG file\n*GenerateBarcodeApi* | [**generate_barcode_ean8**](docs/GenerateBarcodeApi.md#generate_barcode_ean8) | **POST** /barcode/generate/ean-8 | Generate a EAN-8 code barcode as PNG file\n*GenerateBarcodeApi* | [**generate_barcode_qr_code**](docs/GenerateBarcodeApi.md#generate_barcode_qr_code) | **POST** /barcode/generate/qrcode | Generate a QR code barcode as PNG file\n*GenerateBarcodeApi* | [**generate_barcode_upca**](docs/GenerateBarcodeApi.md#generate_barcode_upca) | **POST** /barcode/generate/upc-a | Generate a UPC-A code barcode as PNG file\n*GenerateBarcodeApi* | [**generate_barcode_upce**](docs/GenerateBarcodeApi.md#generate_barcode_upce) | **POST** /barcode/generate/upc-e | Generate a UPC-E code barcode as PNG file\n\n\n## Documentation For Models\n\n - [BarcodeLookupResponse](docs/BarcodeLookupResponse.md)\n - [BarcodeQRResultItem](docs/BarcodeQRResultItem.md)\n - [BarcodeScanQRAdvancedResult](docs/BarcodeScanQRAdvancedResult.md)\n - [BarcodeScanResult](docs/BarcodeScanResult.md)\n - [ProductMatch](docs/ProductMatch.md)\n\n\n## Documentation For Authorization\n\n\n## Apikey\n\n- **Type**: API key\n- **API key parameter name**: Apikey\n- **Location**: HTTP header\n\n\n## Author",
"bugtrack_url": null,
"license": null,
"summary": "barcodeapi",
"version": "3.1.0",
"project_urls": {
"Homepage": "https://www.cloudmersive.com/barcode-api"
},
"split_keywords": [
"swagger",
" barcodeapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "32cb1b87e05c98cb2cb238e8649fc8225feeae99b10eeae43afc896201de35aa",
"md5": "cb59de8fbff75efab3e884bc1c0c2a40",
"sha256": "685b237a494392546343b1f0a86382ac7d937af7f797a1996c43d7ecfae8ddcd"
},
"downloads": -1,
"filename": "cloudmersive_barcode_api_client-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "cb59de8fbff75efab3e884bc1c0c2a40",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20369,
"upload_time": "2024-06-08T23:29:08",
"upload_time_iso_8601": "2024-06-08T23:29:08.537472Z",
"url": "https://files.pythonhosted.org/packages/32/cb/1b87e05c98cb2cb238e8649fc8225feeae99b10eeae43afc896201de35aa/cloudmersive_barcode_api_client-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-08 23:29:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cloudmersive-barcode-api-client"
}
JSON