Tapfiliate

Learn how to use Tapfiliate with Composio

Overview

SLUG: TAPFILIATE

Description

Tapfiliate is an affiliate and referral tracking platform that enables businesses to create, track, and scale their affiliate programs efficiently.

Authentication Details

generic_api_key
stringRequired

Connecting to Tapfiliate

Create an auth config

Use the dashboard to create an auth config for the Tapfiliate toolkit. This allows you to connect multiple Tapfiliate accounts to Composio for agents to use.

1

Select App

Navigate to the Tapfiliate toolkit page and click “Setup Integration”.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Integration”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5tapfiliate_auth_config_id = "ac_YOUR_TAPFILIATE_CONFIG_ID" # Auth config ID created above
6user_id = "0000-0000-0000" # UUID from database/app
7
8composio = Composio()
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 # Replace this with a method to retrieve an API key from the user.
12 # Or supply your own.
13 user_api_key = input("[!] Enter API key")
14
15 connection_request = composio.connected_accounts.initiate(
16 user_id=user_id,
17 auth_config_id=auth_config_id,
18 config={"auth_scheme": "API_KEY", "val": user_api_key}
19 )
20
21 # API Key authentication is immediate - no redirect needed
22 print(f"Successfully connected Tapfiliate for user {user_id}")
23 print(f"Connection status: {connection_request.status}")
24
25 return connection_request.id
26
27
28connection_id = authenticate_toolkit(user_id, tapfiliate_auth_config_id)
29
30# You can verify the connection using:
31connected_account = composio.connected_accounts.get(connection_id)
32print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Tapfiliate toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["TAPFILIATE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: List all affiliates

Description

Tool to list all affiliates. use after verifying api credentials to fetch affiliates with optional filters.

Action Parameters

affiliate_group_id
string
click_id
string
email
string
parent_id
string
referral_code
string
source_id
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Retrieve an Affiliate

Description

Tool to retrieve details of a specific affiliate. use when you have the affiliate id and need full affiliate profile.

Action Parameters

affiliate_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all commissions

Description

Tool to retrieve all commissions. use when you need to fetch commission records with optional filters and pagination after confirming valid api credentials.

Action Parameters

affiliate_id
string
conversion_id
string
created_at_from
string
created_at_to
string
page
integer
per_page
integer
program_id
string
status
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Delete an affiliate

Description

Tool to delete a specific affiliate. use when you need to remove an affiliate by their affiliate id after confirming it exists.

Action Parameters

affiliate_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all affiliates

Description

Tool to list all affiliates. use after confirming api access to fetch affiliates with optional filters.

Action Parameters

affiliate_group_id
string
click_id
string
email
string
parent_id
string
referral_code
string
source_id
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Create a Payment

Description

Tool to create a payment. use when you need to credit an affiliate after confirming transaction details.

Action Parameters

affiliate_id
stringRequired
amount
numberRequired
currency
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all payments

Description

Tool to list all payments. use when you need to retrieve paginated payment records after confirming api credentials.

Action Parameters

page
integer
per_page
integer

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Retrieve a Payment

Description

Tool to retrieve details of a specific payment. use when you have the payment id and need full payment information.

Action Parameters

payment_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all payout methods

Description

Tool to retrieve a list of all payout methods for an affiliate. use when fetching available payment options for an affiliate.

Action Parameters

affiliate_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all programs

Description

Tool to list all programs. use after confirming api credentials to fetch program list with optional asset filters.

Action Parameters

asset_id
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired