@rakohq/sdk
v0.1.0
Published
JavaScript/TypeScript SDK for the Agent Attribution Protocol (AAP)
Maintainers
Readme
@rakohq/sdk
JavaScript/TypeScript SDK for the Agent Attribution Protocol (AAP)
AAP enables AI agents to discover offers, make recommendations, and earn commission when those recommendations lead to purchases.
Install
npm install @rakohq/sdkQuick Start
import { AAP } from '@rakohq/sdk';
const aap = new AAP({ apiKey: 'your-api-key' });
// Search for offers
const { offers, sessionId } = await aap.search({
vertical: 'sim',
maxPrice: 10,
contractMonths: 0,
});
// Recommend an offer (records attribution)
const rec = await aap.recommend({
sessionId,
offerId: offers[0].id,
context: 'User asked for cheap SIM with no contract',
});
// rec.fallbackUrl — give this to the user if they don't buy now
// rec.attributionRecorded — true, commission will be tracked
// Initiate checkout
const checkout = await aap.checkout({
sessionId,
recommendationId: rec.recommendationId,
});API
new AAP(config)
| Option | Type | Required | Default |
|--------|------|----------|---------|
| apiKey | string | Yes | — |
| baseUrl | string | No | https://api.rako.sh |
aap.search(options)
Search for offers. Returns matching offers and a session ID.
| Option | Type | Description |
|--------|------|-------------|
| vertical | string | sim, broadband, energy, flights, hotels, insurance |
| provider | string | Filter by provider name |
| maxPrice | number | Maximum price |
| minDataGb | number | Minimum data (SIM) |
| contractMonths | number | Contract length (0 = rolling) |
aap.recommend(options)
Record a recommendation. This is the attribution event.
| Option | Type | Required | Description |
|--------|------|----------|-------------|
| sessionId | string | Yes | From search() |
| offerId | string | Yes | Offer to recommend |
| context | string | No | Why this was recommended |
aap.checkout(options)
Initiate checkout.
| Option | Type | Required | Description |
|--------|------|----------|-------------|
| sessionId | string | Yes | From search() |
| recommendationId | string | Yes | From recommend() |
| userDetails | object | No | User details for checkout |
aap.getSession(sessionId)
Get session details including recommendations and conversions.
aap.verifyCode(code)
Verify an AAP Code is authentic.
Links
Licence
Apache 2.0
