@ottoafrica/events-sdk-node
v0.1.3
Published
Merchant backend SDK for Otto loyalty/gift-card trigger events
Downloads
26
Readme
@ottoafrica/events-sdk-node
Merchant/backend SDK for Otto loyalty and gift-card trigger events.
Installation
npm install @ottoafrica/events-sdk-nodeQuick start
import { OttoEventsSdk } from "@ottoafrica/events-sdk-node";
const sdk = new OttoEventsSdk({
baseUrl: "https://api.ottoafrica.com",
apiKey: process.env.OTTO_API_KEY
});
const programs = await sdk.getPrograms();
console.log(programs);Usage
await sdk.lookupMember("ABCD-EFGH-IJKL");
await sdk.recordActivity({
member_code: "ABCD-EFGH-IJKL",
amount: 100,
activity_type: "GIFT_CARD_PURCHASE"
});API methods
trackTrigger(eventName, payload)lookupMember(memberCode)getPrograms()getProgram(programId)enrollMember(programId, identifier)recordActivity(payload)listRewards(programId)issueGiftCard(payload)claimGiftCard(token)mintClientToken(payload)
Error handling
On non-2xx responses, SDK throws an Error with:
error.messageerror.httpStatuserror.details(server payload when available)
Support
- API base URL (production):
https://api.ottoafrica.com - Contract reference:
docs/openapi-loyalty-sdk-v1.json
