https://github.com/craftgate/craftgate-node-client
Node.js client for Craftgate API
https://github.com/craftgate/craftgate-node-client
client-library craftgate craftgate-api javascript nodejs nodejs-client payment payment-gateway payment-orchestration typescript
Last synced: 13 days ago
JSON representation
Node.js client for Craftgate API
- Host: GitHub
- URL: https://github.com/craftgate/craftgate-node-client
- Owner: craftgate
- License: mit
- Created: 2020-12-03T13:18:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2026-04-01T12:17:18.000Z (about 1 month ago)
- Last Synced: 2026-04-01T14:19:05.787Z (about 1 month ago)
- Topics: client-library, craftgate, craftgate-api, javascript, nodejs, nodejs-client, payment, payment-gateway, payment-orchestration, typescript
- Language: TypeScript
- Homepage: https://developer.craftgate.io
- Size: 633 KB
- Stars: 37
- Watchers: 12
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Craftgate Node.js Client
[](https://github.com/craftgate/craftgate-node-client/actions?query=branch%3Amaster)
[](https://www.npmjs.com/package/@craftgate/craftgate)
[](https://gitpod.io/#https://github.com/craftgate/craftgate-node-client)
This repo contains the Node.js client for Craftgate API.
[](https://gitpod.io/#https://github.com/craftgate/craftgate-node-client)
## Requirements
- Node.js v4.x+
- If you plan on using this library with older versions of Node (e.g. v0.10.x), you'll only need to include a `Promise` polyfill such as [bluebird](https://github.com/petkaantonov/bluebird)
## Installation
```bash
$ npm install @craftgate/craftgate
```
## Usage
To access the Craftgate API you'll first need to obtain API credentials (e.g. an API key and a secret key). If you don't already have a Craftgate account, you can signup at [https://craftgate.io](https://craftgate.io)
Once you've obtained your API credentials, you can start using Craftgate by instantiating a `CraftgateClient` with your credentials.
```js
const Craftgate = require('@craftgate/craftgate');
const craftgate = new Craftgate.Client({
apiKey: '',
secretKey: ''
});
...
```
By default the Craftgate client connects to the production API servers at `https://api.craftgate.io`. For testing purposes, please use the sandbox URL `https://sandbox-api.craftgate.io` using the .
```js
const Craftgate = require('@craftgate/craftgate');
const craftgate = new Craftgate.Client({
apiKey: '',
secretKey: '',
baseUrl: 'https://sandbox-api.craftgate.io'
});
...
```
### Bulk Import vs. Individual Imports
The root export of the project (e.g. `@craftgate/craftgate`) is designed primarily for CommonJS-style bulk imports, but the project also exports its modules individually, so you can also import them directly in ES6 fashion. On development environments where a transpiler such as Babel or TypeScript exists, we recommend using this approach.
Keep in mind that when using direct imports, you'll have to import necessary modules individually. So this code:
```js
const Craftgate = require('@craftgate/craftgate');
const craftgate = new Craftgate.Client({...});
craftgate.payment().createPayment({
...,
currency: Craftgate.Model.Currency.TRY,
...
})
...
```
becomes like this:
```js
import CraftgateClient from '@craftgate/craftgate/CraftgateClient';
import Currency from '@craftgate/craftgate/model/Currency';
const craftgate = new CraftgateClient({...});
craftgate.payment().createPayment({
...,
currency: Currency.TRY,
...
})
...
```
Also, since we make use of default exports, if you wish to import these modules directly in CommonJS fashion (e.g. `require()`), then make sure you're accessing the `default` keyword of the module.
```js
const CraftgateClient = require('@craftgate/craftgate/CraftgateClient'); // this won't work
...
const CraftgateClient = require('@craftgate/craftgate/CraftgateClient').default; // however, this will
```
## Examples
Included in the project are a number of examples that cover almost all use-cases. Refer to [the `samples/` folder](./samples)] for more info.
Aside from demonstrating different business use cases, we also added technically different variants of certain examples to reflect the diversity in technical stacks. These examples are located under the [samples/misc](./samples/misc) folder, and what they represent are indicated by filename suffixes listed below:
| Filename Suffix | Description |
|-----------------|-------------|
| `.es5.js` | ES5-style JavaScript code with bulk CommonJS imports (e.g. `var` keyword for variables, `require()` keyword for imports, inline `function()` blocks) |
| `.es6.js` | ES6-style JavaScript code with ES6 imports (e.g. `let/const` keyword for variables, `import` keyword for imports, lambda expressions) |
| `.ts` | TypeScript code |
| `.js` | Node.js v6+ (ES6-style JavaScript code with direct CommonJS imports) (e.g. `let/const` keyword for variables, `require()` keyword for imports, lambda expressions) |
### Running the Examples
If you've cloned this repo on your development machine and wish to run the examples directly, make sure to install the dependencies using `npm i` and build the library using `npm run build`. Once the library is built, you can run an example with the command `node ` (e.g. `node samples/payment/RetrievePayment.js`).
Keep in mind that the `node` interpreter cannot be used to execute TypeScript files, whereas the `ts-node` can. This interpreter does not ship with Node.js itself, so you'll either have to install it globally on your machine, or include it in your project as a dependency. This repository already includes it as a dev dependency, and exposes it as an NPM task with the name`ts-node`, so to run a TypeScript example you can simply execute the command `npm run ts-node ` (e.g. `npm run ts-node samples/misc/CreatePayment.ts`).
### Credit Card Payment Use Case (ES5-Style)
Let's quickly review an example where we implement a credit card payment scenario using an ES5-style approach
> For more examples covering almost all use-cases, check out the [examples in the `samples/` folder](./samples)
```js
var Craftgate = require('../dist');
var craftgate = new Craftgate.Client({
apiKey: 'api-key',
secretKey: 'secret-key',
baseUrl: 'https://sandbox-api.craftgate.io'
});
var request = {
price: 100.0,
paidPrice: 100.0,
walletPrice: 0.0,
installment: 1,
conversationId: '456d1297-908e-4bd6-a13b-4be31a6e47d5',
currency: Craftgate.Model.Currency.TRY,
paymentGroup: Craftgate.Model.PaymentGroup.ListingOrSubscription,
card: {
cardHolderName: 'Haluk Demir',
cardNumber: '5258640000000001',
expireYear: '2044',
expireMonth: '07',
cvc: '000'
},
items: [
{
name: 'Item 1',
price: 30.0,
externalId: '123d1297-839e-4bd6-a13b-4be31a6e12a8'
},
{
name: 'Item 2',
price: 50.0,
externalId: '789d1297-839e-4bd6-a13b-4be31a6e13f7'
},
{
name: 'Item 3',
price: 20.0,
externalId: '3a1d1297-839e-4bd6-a13b-4be31a6e18e6'
}
]
};
craftgate.payment().createPayment(request)
.then(function(result) {
console.info('Payment successful', result);
})
.catch(function(err) {
console.error('Payment failed', err);
});
```
## Development
To contribute to the project, please see our guidelines at [CONTRIBUTING](./CONTRIBUTING.md)
## License
MIT