https://github.com/cloudmersive/cloudmersive.apiclient.nodejs.barcode
NodeJS client for Cloudmersive Barcode API
https://github.com/cloudmersive/cloudmersive.apiclient.nodejs.barcode
barcode
Last synced: 8 months ago
JSON representation
NodeJS client for Cloudmersive Barcode API
- Host: GitHub
- URL: https://github.com/cloudmersive/cloudmersive.apiclient.nodejs.barcode
- Owner: Cloudmersive
- License: apache-2.0
- Created: 2018-06-23T21:01:04.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-08T23:02:27.000Z (about 2 years ago)
- Last Synced: 2024-06-09T00:20:22.437Z (about 2 years ago)
- Topics: barcode
- Language: JavaScript
- Size: 14.9 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cloudmersive-barcodeapi-client
CloudmersiveBarcodeapiClient - JavaScript client for cloudmersive-barcodeapi-client
Barcode APIs let you generate barcode images, and recognize values from images of barcodes.
[Cloudmersive Barcode API](https://www.cloudmersive.com/barcode-api) provides advanced barcode generation, lookup and recognition capabilities.
- API version: v1
- Package version: 1.2.0
## Installation
### For [Node.js](https://nodejs.org/)
#### npm
To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
Then install it via:
```shell
npm install cloudmersive-barcodeapi-client --save
```
##### Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
```shell
npm install
```
Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
```shell
npm link
```
Finally, switch to the directory you want to use your cloudmersive-barcodeapi-client from, and run:
```shell
npm link /path/to/
```
You should now be able to `require('cloudmersive-barcodeapi-client')` in javascript files from the directory you ran the last
command above from.
#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:
```shell
npm install GIT_USER_ID/GIT_REPO_ID --save
```
### For browser
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually
use this library):
```shell
browserify main.js > bundle.js
```
Then include *bundle.js* in the HTML pages.
### Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:
```javascript
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
```
## Getting Started
Please follow the [installation](#installation) instruction and execute the following JS code:
```javascript
var CloudmersiveBarcodeapiClient = require('cloudmersive-barcodeapi-client');
var defaultClient = CloudmersiveBarcodeapiClient.ApiClient.instance;
// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix['Apikey'] = "Token"
var api = new CloudmersiveBarcodeapiClient.BarcodeLookupApi()
var value = "value_example"; // {String} Barcode value
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.barcodeLookupEanLookup(value, callback);
```
## Documentation for API Endpoints
All URIs are relative to *https://api.cloudmersive.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CloudmersiveBarcodeapiClient.BarcodeLookupApi* | [**barcodeLookupEanLookup**](docs/BarcodeLookupApi.md#barcodeLookupEanLookup) | **POST** /barcode/lookup/ean | Lookup EAN barcode value, return product data
*CloudmersiveBarcodeapiClient.BarcodeScanApi* | [**barcodeScanImage**](docs/BarcodeScanApi.md#barcodeScanImage) | **POST** /barcode/scan/image | Scan and recognize an image of a barcode
*CloudmersiveBarcodeapiClient.BarcodeScanApi* | [**barcodeScanImageAdvancedQR**](docs/BarcodeScanApi.md#barcodeScanImageAdvancedQR) | **POST** /barcode/scan/image/advanced/qr | Advanced AI scan and recognition of an image of one or more QR barcodes
*CloudmersiveBarcodeapiClient.GenerateBarcodeApi* | [**generateBarcodeEAN13**](docs/GenerateBarcodeApi.md#generateBarcodeEAN13) | **POST** /barcode/generate/ean-13 | Generate a EAN-13 code barcode as PNG file
*CloudmersiveBarcodeapiClient.GenerateBarcodeApi* | [**generateBarcodeEAN8**](docs/GenerateBarcodeApi.md#generateBarcodeEAN8) | **POST** /barcode/generate/ean-8 | Generate a EAN-8 code barcode as PNG file
*CloudmersiveBarcodeapiClient.GenerateBarcodeApi* | [**generateBarcodeQRCode**](docs/GenerateBarcodeApi.md#generateBarcodeQRCode) | **POST** /barcode/generate/qrcode | Generate a QR code barcode as PNG file
*CloudmersiveBarcodeapiClient.GenerateBarcodeApi* | [**generateBarcodeUPCA**](docs/GenerateBarcodeApi.md#generateBarcodeUPCA) | **POST** /barcode/generate/upc-a | Generate a UPC-A code barcode as PNG file
*CloudmersiveBarcodeapiClient.GenerateBarcodeApi* | [**generateBarcodeUPCE**](docs/GenerateBarcodeApi.md#generateBarcodeUPCE) | **POST** /barcode/generate/upc-e | Generate a UPC-E code barcode as PNG file
## Documentation for Models
- [CloudmersiveBarcodeapiClient.BarcodeLookupResponse](docs/BarcodeLookupResponse.md)
- [CloudmersiveBarcodeapiClient.BarcodeQRResultItem](docs/BarcodeQRResultItem.md)
- [CloudmersiveBarcodeapiClient.BarcodeScanQRAdvancedResult](docs/BarcodeScanQRAdvancedResult.md)
- [CloudmersiveBarcodeapiClient.BarcodeScanResult](docs/BarcodeScanResult.md)
- [CloudmersiveBarcodeapiClient.ProductMatch](docs/ProductMatch.md)
## Documentation for Authorization
### Apikey
- **Type**: API key
- **API key parameter name**: Apikey
- **Location**: HTTP header