Can I use Tapfiliate as a CLI?

Yes. KosmoKrator exposes a Tapfiliate CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Tapfiliate through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Tapfiliate tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Tapfiliate credentials stored?

Tapfiliate credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Tapfiliate MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

analytics

Tapfiliate CLI for AI Agents

Use the Tapfiliate CLI from KosmoKrator to call Tapfiliate tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

Tapfiliate CLI Setup

Tapfiliate can be configured headlessly with `kosmokrator integrations:configure tapfiliate`.

Install, configure, and verify

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure tapfiliate --set api_key="$TAPFILIATE_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor tapfiliate --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

Key	Env var	Type	Required	Label
`api_key`	`TAPFILIATE_API_KEY`	Secret `secret`	yes	API Key
`url`	`TAPFILIATE_URL`	URL `url`	no	API Base URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call

kosmo integrations:call tapfiliate.tapfiliate_get_current_user '{}' --json

Provider shortcut

kosmo integrations:tapfiliate tapfiliate_get_current_user '{}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands

kosmo integrations:docs tapfiliate --json
kosmo integrations:docs tapfiliate.tapfiliate_get_current_user --json
kosmo integrations:schema tapfiliate.tapfiliate_get_current_user --json
kosmo integrations:search "Tapfiliate" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`tapfiliate.tapfiliate_get_current_user`

Get the currently authenticated Tapfiliate user profile. Useful for verifying API credentials and checking account details.

Read read

Parameters: none

Generic call

kosmo integrations:call tapfiliate.tapfiliate_get_current_user '{}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_get_current_user '{}' --json

`tapfiliate.tapfiliate_list_affiliates`

List affiliates in your Tapfiliate account. Returns paginated results with affiliate IDs, emails, names, and status.

Read read

Parameters: limit, page, email, referral_code, click_id, source_id, parent_id, affiliate_group_id

Generic call

kosmo integrations:call tapfiliate.tapfiliate_list_affiliates '{"limit":1,"page":1,"email":"example_email","referral_code":"example_referral_code","click_id":"example_click_id","source_id":"example_source_id","parent_id":"example_parent_id","affiliate_group_id":"example_affiliate_group_id"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_list_affiliates '{"limit":1,"page":1,"email":"example_email","referral_code":"example_referral_code","click_id":"example_click_id","source_id":"example_source_id","parent_id":"example_parent_id","affiliate_group_id":"example_affiliate_group_id"}' --json

`tapfiliate.tapfiliate_get_affiliate`

Get detailed information about a specific affiliate by their ID. Includes email, name, status, and metadata.

Read read

Parameters: id

Generic call

kosmo integrations:call tapfiliate.tapfiliate_get_affiliate '{"id":"example_id"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_get_affiliate '{"id":"example_id"}' --json

`tapfiliate.tapfiliate_create_affiliate`

Create a Tapfiliate affiliate with profile, company, address, and custom field data.

Write write

Parameters: firstname, lastname, email, password, company, address, custom_fields

Generic call

kosmo integrations:call tapfiliate.tapfiliate_create_affiliate '{"firstname":"example_firstname","lastname":"example_lastname","email":"example_email","password":"example_password","company":"example_company","address":"example_address","custom_fields":"example_custom_fields"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_create_affiliate '{"firstname":"example_firstname","lastname":"example_lastname","email":"example_email","password":"example_password","company":"example_company","address":"example_address","custom_fields":"example_custom_fields"}' --json

`tapfiliate.tapfiliate_update_affiliate`

Update a Tapfiliate affiliate profile, company, address, or custom field data.

Write write

Parameters: affiliate_id, firstname, lastname, email, company, address, custom_fields

Generic call

kosmo integrations:call tapfiliate.tapfiliate_update_affiliate '{"affiliate_id":"example_affiliate_id","firstname":"example_firstname","lastname":"example_lastname","email":"example_email","company":"example_company","address":"example_address","custom_fields":"example_custom_fields"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_update_affiliate '{"affiliate_id":"example_affiliate_id","firstname":"example_firstname","lastname":"example_lastname","email":"example_email","company":"example_company","address":"example_address","custom_fields":"example_custom_fields"}' --json

`tapfiliate.tapfiliate_delete_affiliate`

Delete a Tapfiliate affiliate by ID.

Write write

Parameters: affiliate_id

Generic call

kosmo integrations:call tapfiliate.tapfiliate_delete_affiliate '{"affiliate_id":"example_affiliate_id"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_delete_affiliate '{"affiliate_id":"example_affiliate_id"}' --json

`tapfiliate.tapfiliate_set_affiliate_group`

Assign an affiliate to a Tapfiliate affiliate group.

Write write

Parameters: affiliate_id, group_id

Generic call

kosmo integrations:call tapfiliate.tapfiliate_set_affiliate_group '{"affiliate_id":"example_affiliate_id","group_id":"example_group_id"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_set_affiliate_group '{"affiliate_id":"example_affiliate_id","group_id":"example_group_id"}' --json

`tapfiliate.tapfiliate_list_affiliate_notes`

List notes attached to a Tapfiliate affiliate.

Read read

Parameters: affiliate_id

Generic call

kosmo integrations:call tapfiliate.tapfiliate_list_affiliate_notes '{"affiliate_id":"example_affiliate_id"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_list_affiliate_notes '{"affiliate_id":"example_affiliate_id"}' --json

`tapfiliate.tapfiliate_list_affiliate_groups`

List all Tapfiliate affiliate groups.

Read read

Parameters: none

Generic call

kosmo integrations:call tapfiliate.tapfiliate_list_affiliate_groups '{}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_list_affiliate_groups '{}' --json

`tapfiliate.tapfiliate_list_conversions`

List conversions in your Tapfiliate account. Supports filtering by affiliate, campaign, date range, and status. Results are paginated.

Read read

Parameters: affiliate_id, program_id, external_id, status, date_from, date_to, limit, page

Generic call

kosmo integrations:call tapfiliate.tapfiliate_list_conversions '{"affiliate_id":"example_affiliate_id","program_id":"example_program_id","external_id":"example_external_id","status":"example_status","date_from":"example_date_from","date_to":"example_date_to","limit":1,"page":1}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_list_conversions '{"affiliate_id":"example_affiliate_id","program_id":"example_program_id","external_id":"example_external_id","status":"example_status","date_from":"example_date_from","date_to":"example_date_to","limit":1,"page":1}' --json

`tapfiliate.tapfiliate_get_conversion`

Get a Tapfiliate conversion by ID.

Read read

Parameters: conversion_id

Generic call

kosmo integrations:call tapfiliate.tapfiliate_get_conversion '{"conversion_id":"example_conversion_id"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_get_conversion '{"conversion_id":"example_conversion_id"}' --json

`tapfiliate.tapfiliate_create_conversion`

Create a new conversion in Tapfiliate. Associates a revenue amount with an affiliate using a unique external ID (e.g., order ID or transaction reference).

Write write

Parameters: affiliate_id, referral_code, tracking_id, click_id, coupon, amount, external_id, program_id, currency, customer_id, commission_type, commissions, meta_data

Generic call

kosmo integrations:call tapfiliate.tapfiliate_create_conversion '{"affiliate_id":"example_affiliate_id","referral_code":"example_referral_code","tracking_id":"example_tracking_id","click_id":"example_click_id","coupon":"example_coupon","amount":1,"external_id":"example_external_id","program_id":"example_program_id"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_create_conversion '{"affiliate_id":"example_affiliate_id","referral_code":"example_referral_code","tracking_id":"example_tracking_id","click_id":"example_click_id","coupon":"example_coupon","amount":1,"external_id":"example_external_id","program_id":"example_program_id"}' --json

`tapfiliate.tapfiliate_add_conversion_commission`

Add a commission line to a Tapfiliate conversion.

Write write

Parameters: conversion_id, conversion_sub_amount, commission_type, comment

Generic call

kosmo integrations:call tapfiliate.tapfiliate_add_conversion_commission '{"conversion_id":"example_conversion_id","conversion_sub_amount":1,"commission_type":"example_commission_type","comment":"example_comment"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_add_conversion_commission '{"conversion_id":"example_conversion_id","conversion_sub_amount":1,"commission_type":"example_commission_type","comment":"example_comment"}' --json

`tapfiliate.tapfiliate_list_commissions`

List Tapfiliate commissions with optional filters.

Read read

Parameters: affiliate_id, conversion_id, program_id, status, date_from, date_to, page, limit

Generic call

kosmo integrations:call tapfiliate.tapfiliate_list_commissions '{"affiliate_id":"example_affiliate_id","conversion_id":"example_conversion_id","program_id":"example_program_id","status":"example_status","date_from":"example_date_from","date_to":"example_date_to","page":1,"limit":1}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_list_commissions '{"affiliate_id":"example_affiliate_id","conversion_id":"example_conversion_id","program_id":"example_program_id","status":"example_status","date_from":"example_date_from","date_to":"example_date_to","page":1,"limit":1}' --json

`tapfiliate.tapfiliate_get_commission`

Get a Tapfiliate commission by ID.

Read read

Parameters: commission_id

Generic call

kosmo integrations:call tapfiliate.tapfiliate_get_commission '{"commission_id":"example_commission_id"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_get_commission '{"commission_id":"example_commission_id"}' --json

`tapfiliate.tapfiliate_list_customers`

List Tapfiliate customers with optional program, customer, affiliate, and date filters.

Read read

Parameters: program_id, customer_id, affiliate_id, date_from, date_to

Generic call

kosmo integrations:call tapfiliate.tapfiliate_list_customers '{"program_id":"example_program_id","customer_id":"example_customer_id","affiliate_id":"example_affiliate_id","date_from":"example_date_from","date_to":"example_date_to"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_list_customers '{"program_id":"example_program_id","customer_id":"example_customer_id","affiliate_id":"example_affiliate_id","date_from":"example_date_from","date_to":"example_date_to"}' --json

`tapfiliate.tapfiliate_create_customer`

Create or track a Tapfiliate customer for recurring and lifetime commission workflows.

Write write

Parameters: customer_id, referral_code, tracking_id, click_id, coupon, status, program_id, meta_data

Generic call

kosmo integrations:call tapfiliate.tapfiliate_create_customer '{"customer_id":"example_customer_id","referral_code":"example_referral_code","tracking_id":"example_tracking_id","click_id":"example_click_id","coupon":"example_coupon","status":"example_status","program_id":"example_program_id","meta_data":"example_meta_data"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_create_customer '{"customer_id":"example_customer_id","referral_code":"example_referral_code","tracking_id":"example_tracking_id","click_id":"example_click_id","coupon":"example_coupon","status":"example_status","program_id":"example_program_id","meta_data":"example_meta_data"}' --json

`tapfiliate.tapfiliate_list_programs`

List Tapfiliate affiliate programs.

Read read

Parameters: none

Generic call

kosmo integrations:call tapfiliate.tapfiliate_list_programs '{}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_list_programs '{}' --json

`tapfiliate.tapfiliate_get_program_affiliate`

Get an affiliate enrollment within a Tapfiliate program.

Read read

Parameters: program_id, affiliate_id

Generic call

kosmo integrations:call tapfiliate.tapfiliate_get_program_affiliate '{"program_id":"example_program_id","affiliate_id":"example_affiliate_id"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_get_program_affiliate '{"program_id":"example_program_id","affiliate_id":"example_affiliate_id"}' --json

`tapfiliate.tapfiliate_update_program_affiliate`

Update an affiliate enrollment within a Tapfiliate program.

Write write

Parameters: program_id, affiliate_id, coupon

Generic call

kosmo integrations:call tapfiliate.tapfiliate_update_program_affiliate '{"program_id":"example_program_id","affiliate_id":"example_affiliate_id","coupon":"example_coupon"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_update_program_affiliate '{"program_id":"example_program_id","affiliate_id":"example_affiliate_id","coupon":"example_coupon"}' --json

`tapfiliate.tapfiliate_list_program_commission_types`

List commission types for a Tapfiliate program.

Read read

Parameters: program_id

Generic call

kosmo integrations:call tapfiliate.tapfiliate_list_program_commission_types '{"program_id":"example_program_id"}' --json

Shortcut

kosmo integrations:tapfiliate tapfiliate_list_program_commission_types '{"program_id":"example_program_id"}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

tapfiliate.tapfiliate_get_current_user 0 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_get_current_user --json

Parameter	Type	Required	Description
No parameters.

tapfiliate.tapfiliate_list_affiliates 8 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_list_affiliates --json

Parameter	Type	Required	Description
`limit`	integer	no	Number of affiliates per page (default: 25, max: 100).
`page`	integer	no	Page number for pagination (default: 1).
`email`	string	no	Filter by email address.
`referral_code`	string	no	Filter by affiliate referral code.
`click_id`	string	no	Filter by click id.
`source_id`	string	no	Filter by source id.
`parent_id`	string	no	Retrieve children for a parent affiliate.
`affiliate_group_id`	string	no	Filter by affiliate group id.

tapfiliate.tapfiliate_get_affiliate 1 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_get_affiliate --json

Parameter	Type	Required	Description
`id`	string	yes	The affiliate ID.

tapfiliate.tapfiliate_create_affiliate 7 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_create_affiliate --json

Parameter	Type	Required	Description
`firstname`	string	yes	Affiliate first name.
`lastname`	string	yes	Affiliate last name.
`email`	string	yes	Affiliate email address.
`password`	string	no	Optional affiliate portal password.
`company`	object	no	Company object, for example {name: "..."}
`address`	object	no	Address object with address, postal_code, city, state, and country code.
`custom_fields`	object	no	Custom field values.

tapfiliate.tapfiliate_update_affiliate 7 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_update_affiliate --json

Parameter	Type	Required	Description
`affiliate_id`	string	yes	Affiliate ID to update.
`firstname`	string	no	Affiliate first name.
`lastname`	string	no	Affiliate last name.
`email`	string	no	Affiliate email address.
`company`	object	no	Company object.
`address`	object	no	Address object.
`custom_fields`	object	no	Custom field values.

tapfiliate.tapfiliate_delete_affiliate 1 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_delete_affiliate --json

Parameter	Type	Required	Description
`affiliate_id`	string	yes	Affiliate ID to delete.

tapfiliate.tapfiliate_set_affiliate_group 2 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_set_affiliate_group --json

Parameter	Type	Required	Description
`affiliate_id`	string	yes	Affiliate ID.
`group_id`	string	yes	Affiliate group ID.

tapfiliate.tapfiliate_list_affiliate_notes 1 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_list_affiliate_notes --json

Parameter	Type	Required	Description
`affiliate_id`	string	yes	Affiliate ID.

tapfiliate.tapfiliate_list_affiliate_groups 0 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_list_affiliate_groups --json

Parameter	Type	Required	Description
No parameters.

tapfiliate.tapfiliate_list_conversions 8 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_list_conversions --json

Parameter	Type	Required	Description
`affiliate_id`	string	no	Filter by affiliate ID.
`program_id`	string	no	Filter by program ID.
`external_id`	string	no	Filter by external ID (e.g., order or transaction ID).
`status`	string	no	Filter by status: "approved", "pending", or "rejected".
`date_from`	string	no	Start date filter (ISO 8601, e.g., "2025-01-01").
`date_to`	string	no	End date filter (ISO 8601, e.g., "2025-12-31").
`limit`	integer	no	Number of results per page (default: 25, max: 100).
`page`	integer	no	Page number for pagination (default: 1).

tapfiliate.tapfiliate_get_conversion 1 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_get_conversion --json

Parameter	Type	Required	Description
`conversion_id`	string	yes	Conversion ID.

tapfiliate.tapfiliate_create_conversion 13 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_create_conversion --json

Parameter	Type	Required	Description
`affiliate_id`	string	no	The ID of the affiliate to credit when known.
`referral_code`	string	no	Affiliate referral code, matching the ref= value in referral links.
`tracking_id`	string	no	Tracking id from Tapfiliate.js.
`click_id`	string	no	Click id for additional reporting.
`coupon`	string	no	Coupon code to attribute the conversion.
`amount`	number	no	The conversion amount (e.g., 29.99).
`external_id`	string	yes	A unique external reference (e.g., order ID, transaction ID).
`program_id`	string	no	Program ID.
`currency`	string	no	Three-letter ISO currency code.
`customer_id`	string	no	Customer id for recurring or lifetime commission workflows.
`commission_type`	string	no	Commission type id.
`commissions`	array	no	Commission override array. Overrides amount and commission_type when supplied.
`meta_data`	object	no	Optional key-value metadata to attach to the conversion.

tapfiliate.tapfiliate_add_conversion_commission 4 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_add_conversion_commission --json

Parameter	Type	Required	Description
`conversion_id`	string	yes	Conversion ID.
`conversion_sub_amount`	number	yes	Amount on which commission should be calculated.
`commission_type`	string	no	Optional commission type id.
`comment`	string	no	Optional affiliate-visible comment.

tapfiliate.tapfiliate_list_commissions 8 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_list_commissions --json

Parameter	Type	Required	Description
`affiliate_id`	string	no	Filter by affiliate ID.
`conversion_id`	string	no	Filter by conversion ID.
`program_id`	string	no	Filter by program ID.
`status`	string	no	Filter by commission status.
`date_from`	string	no	Start date filter.
`date_to`	string	no	End date filter.
`page`	integer	no	Page number.
`limit`	integer	no	Page size.

tapfiliate.tapfiliate_get_commission 1 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_get_commission --json

Parameter	Type	Required	Description
`commission_id`	string	yes	Commission ID.

tapfiliate.tapfiliate_list_customers 5 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_list_customers --json

Parameter	Type	Required	Description
`program_id`	string	no	Filter by program ID.
`customer_id`	string	no	Filter by customer ID in your system.
`affiliate_id`	string	no	Filter by affiliate ID.
`date_from`	string	no	Start date filter.
`date_to`	string	no	End date filter.

tapfiliate.tapfiliate_create_customer 8 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_create_customer --json

Parameter	Type	Required	Description
`customer_id`	string	yes	Unique customer ID in your system.
`referral_code`	string	no	Affiliate referral code.
`tracking_id`	string	no	Tracking id from Tapfiliate.js.
`click_id`	string	no	Click id.
`coupon`	string	no	Coupon code.
`status`	string	no	Initial customer status. Defaults to new upstream.
`program_id`	string	no	Program ID.
`meta_data`	object	no	Optional metadata.

tapfiliate.tapfiliate_list_programs 0 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_list_programs --json

Parameter	Type	Required	Description
No parameters.

tapfiliate.tapfiliate_get_program_affiliate 2 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_get_program_affiliate --json

Parameter	Type	Required	Description
`program_id`	string	yes	Program ID.
`affiliate_id`	string	yes	Affiliate ID.

tapfiliate.tapfiliate_update_program_affiliate 3 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_update_program_affiliate --json

Parameter	Type	Required	Description
`program_id`	string	yes	Program ID.
`affiliate_id`	string	yes	Affiliate ID.
`coupon`	string	no	Coupon code to assign to the affiliate in this program.

tapfiliate.tapfiliate_list_program_commission_types 1 parameters

Schema command

kosmo integrations:schema tapfiliate.tapfiliate_list_program_commission_types --json

Parameter	Type	Required	Description
`program_id`	string	yes	Program ID.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.