overeno-zakazniky

Heureka Ověřeno zákazníky (ShopCertification) service API client implementation for Node.js/TypeScript.

Installation

# npm
npm install overeno-zakazniky

# yarn
yarn add overeno-zakazniky

# pnpm
pnpm add overeno-zakazniky

Usage

Initialize the ShopCertification class using your API key (you need to log in):

import { ShopCertification } from 'overeno-zakazniky'

const shopCertification = new ShopCertification({
  apiKey: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
})

Important Security Note: Your API key should be kept secret. Never expose it in client-side JavaScript or share it publicly. It should only be used in server-side code. If you need to implement something different, please consult our support department.

For Slovak Shops

Slovak shops should initialize the class with the 'SK' service parameter:

const shopCertification = new ShopCertification({
  apiKey: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
  service: 'SK'
})

Logging Orders

You can log orders with various levels of detail:

Minimal Example (Required Fields Only)

await shopCertification.logOrder({
  email: 'customer@example.com'
})

Complete Example (All Fields)

await shopCertification.logOrder({
  email: 'customer@example.com',
  orderId: '15195618851564',
  productIds: ['B1234', '15968421', '814687']
})

API Response

The logOrder method returns a Promise that resolves to an API response object:

interface ApiResponse {
  code: number
  message: string
}

Error Handling

The module implements several validations:

• Email is required
• Order ID length must not exceed 255 characters
• Duplicate order submissions are prevented
• API communication errors are properly handled

Example with error handling:

try {
  const response = await shopCertification.logOrder({
    email: 'customer@example.com',
    orderId: '12345'
  })
  console.log('Order logged successfully:', response)
}
catch (error) {
  console.error('Failed to log order:', error.message)
}

Typescript Support

This module is written in TypeScript and includes type definitions out of the box.

Development

Running Tests

# npm
npm run test

# yarn
yarn test

# pnpm
pnpm test

Building

# npm
npm run build

# yarn
yarn build

# pnpm
pnpm build

License

MIT License © 2024-PRESENT Andreas Sonnleitner

Support

For any questions about the service itself, please contact Heureka support.

For technical issues with this NPM module, please open an issue on GitHub.