{"_id":"@brandpos_sdk/sdk","_rev":"2-93a16029ff039be080731df2dee5bca5","name":"@brandpos_sdk/sdk","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@brandpos_sdk/sdk","version":"1.0.0","keywords":["brandpos","sdk","pos","terminal","payment"],"author":{"name":"BrandPOS"},"license":"ISC","_id":"@brandpos_sdk/sdk@1.0.0","maintainers":[{"name":"brandpos-sdk","email":"support@brandpos.de"},{"name":"mohanatbc","email":"mohan_s@brandcrock.com"}],"dist":{"shasum":"43d0e24307695391064e1383bfdff41705132cc0","tarball":"https://registry.npmjs.org/@brandpos_sdk/sdk/-/sdk-1.0.0.tgz","fileCount":15,"integrity":"sha512-532lH/sYvYCcrxHZOM+zZ4g2xFaat9/cHGDuWZPtWgAZTSOKjaGxSqMHk4tPD/fp9JjgyGaMeqddjfwzKxLMwQ==","signatures":[{"sig":"MEQCIEiGW0MYHapYFBiS+yd1+Ui8/s0XvxRWCDf9+z+QKR78AiAQOtZFhy299ti7qvT7DoQorHuq3Y5dS5vfvftnc/3FWA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":23849},"main":"src/index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"brandpos-sdk","email":"support@brandpos.de"},"_npmVersion":"10.9.2","description":"Official BrandPOS JavaScript SDK","directories":{},"_nodeVersion":"22.17.0","dependencies":{"axios":"^1.6.2","dotenv":"^16.3.1","crypto-js":"^4.2.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/sdk_1.0.0_1767696458739_0.3007568030250305","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@brandpos_sdk/sdk","version":"1.0.1","description":"Official BrandPOS JavaScript SDK","main":"src/index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["brandpos","sdk","pos","terminal","payment"],"author":{"name":"BrandPOS"},"license":"ISC","dependencies":{"axios":"^1.6.2","crypto-js":"^4.2.0","dotenv":"^16.3.1"},"_id":"@brandpos_sdk/sdk@1.0.1","_nodeVersion":"22.17.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-NSCHzUQ/winDozpNnyeoXdWeO2/rrMAuWYLBQ1JWPCpfs6BMa2Po0xtvvnsvjRvc5BzDu6zbGZxVW4hqr1JaNQ==","shasum":"b6ed8cc16e0d5dc4827fa1bf2848d2a8094168c1","tarball":"https://registry.npmjs.org/@brandpos_sdk/sdk/-/sdk-1.0.1.tgz","fileCount":15,"unpackedSize":23847,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQC1mz2UTwdOv/sFxSZBHjn1EaW4Jgtky2xUcbEMWX54pQIgfe8yCG/W5TNkbbMGZGmwvINbIekXjklz5oGjjlsEO7E="}]},"_npmUser":{"name":"brandpos-sdk","email":"support@brandpos.de"},"directories":{},"maintainers":[{"name":"brandpos-sdk","email":"support@brandpos.de"},{"name":"mohanatbc","email":"mohan_s@brandcrock.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sdk_1.0.1_1767697089838_0.8978253933764238"},"_hasShrinkwrap":false}},"time":{"created":"2026-01-06T10:47:38.632Z","modified":"2026-01-06T10:58:10.155Z","1.0.0":"2026-01-06T10:47:38.904Z","1.0.1":"2026-01-06T10:58:09.960Z"},"author":{"name":"BrandPOS"},"license":"ISC","keywords":["brandpos","sdk","pos","terminal","payment"],"description":"Official BrandPOS JavaScript SDK","maintainers":[{"name":"brandpos-sdk","email":"support@brandpos.de"},{"name":"mohanatbc","email":"mohan_s@brandcrock.com"}],"readme":"# BrandPOS SDK\n\nProduction-ready JavaScript SDK for BrandPOS REST APIs.\n\n## Installation\n\n```bash\nnpm install @brandpos/sdk\n```\n\n## Configuration\n\nThe SDK requires an AES encryption key provided via `BRANDPOS_SDK_KEY` environment variable.\n\nCreate a `.env` file in your project:\n```env\nBRANDPOS_SDK_KEY=your_aes_key_here\n```\n\n## Usage\n\n```javascript\nconst BrandPOS = require('@brandpos/sdk');\nrequire('dotenv').config();\n\nconst sdk = new BrandPOS({\n  apiKey: process.env.BRANDPOS_SDK_KEY,\n  baseUrl: process.env.BRANDPOS_SDK_BASE_URL\n});\n\n// Register a terminal\nasync function registerTerminal() {\n  try {\n    const result = await sdk.terminal.register({\n      Payload: {\n        model_code: 'MC-2023'\n      }\n    });\n    console.log('Terminal Registered:', result);\n  } catch (error) {\n    console.error('Error:', error.message);\n  }\n}\n\nregisterTerminal();\n```\n\n## Security Best Practices\n\n1. **Protect your Secret Key**: Never hardcode the `BRANDPOS_SDK_KEY` in your source code. Use environment variables and secret management services.\n2. **Client-side Caution**: While this is a JavaScript SDK, be careful about using it in public-facing frontend apps where the `BRANDPOS_SDK_KEY` might be exposed to users. It is best used in backend (Node.js) or secure terminal environments.\n3. **Validate Input**: Always validate the payload before sending it to the SDK to avoid unnecessary API calls.\n4. **Error Handling**: Implement robust error handling (as shown in the example) to manage API errors gracefully.\n","readmeFilename":"README.md"}