Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tapfiliate Affiliates API

Manage affiliates, their groups, notes, and payout methods

Tapfiliate Affiliates API is one of 10 APIs that Tapfiliate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Affiliates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 24 operations across 14 paths, and defines 10 schemas. It is described by OpenAPI 3.0.3, at version 1.6.

Requests are made against a single base URL, https://api.tapfiliate.com/1.6.

24 operations 14 paths 10 schemas 5 DELETE11 GET1 PATCH2 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.6
Base URL
https://api.tapfiliate.com/1.6/
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Tapfiliate Affiliates API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 24

Across 14 paths, the API surfaces 24 operations — 5 DELETE, 11 GET, 1 PATCH, 2 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Affiliates 24

Manage affiliates, their groups, notes, and payout methods

GET
/affiliates/{affiliate_id}/
Retrieve an affiliate
getAffiliate 1 param → 200401404
DELETE
/affiliates/{affiliate_id}/
Delete an affiliate
deleteAffiliate 1 param → 204401404
GET
/affiliates/
List all affiliates
listAffiliates 4 params → 200401
POST
/affiliates/
Create an affiliate
createAffiliate body → 201401422
PUT
/affiliates/{affiliate_id}/group/
Set affiliate group
setAffiliateGroup 1 param body → 200401404
DELETE
/affiliates/{affiliate_id}/group/
Remove affiliate group
removeAffiliateGroup 1 param → 200401404
PATCH
/affiliates/{affiliate_id}/notes/{id}/
Update note
updateAffiliateNote 2 params body → 200401404
DELETE
/affiliates/{affiliate_id}/notes/{id}/
Delete note
deleteAffiliateNote 2 params → 204401404
GET
/affiliates/{affiliate_id}/notes/
List notes
listAffiliateNotes 1 param → 200401404
POST
/affiliates/{affiliate_id}/notes/
Create note
createAffiliateNote 1 param body → 201401404
GET
/affiliates/{affiliate_id}/meta-data/
Retrieve meta data for an Affiliate
getAffiliateMetaData 1 param → 200401404
PUT
/affiliates/{affiliate_id}/meta-data/
Update (replace) meta data for an Affiliate
replaceAffiliateMetaData 1 param body → 200401404
GET
/affiliates/{affiliate_id}/meta-data/{key}/
Retrieve meta data by key for an Affiliate
getAffiliateMetaDataByKey 2 params → 200401404
PUT
/affiliates/{affiliate_id}/meta-data/{key}/
Set meta data by key for an Affiliate
setAffiliateMetaDataByKey 2 params body → 200401404
DELETE
/affiliates/{affiliate_id}/meta-data/{key}/
Delete meta data by key for an Affiliate
deleteAffiliateMetaDataByKey 2 params → 204401404
GET
/affiliates/{affiliate_id}/payout-methods/{payout_method_id}/
Get payout method
getPayoutMethod 2 params → 200401404
PUT
/affiliates/{affiliate_id}/payout-methods/{payout_method_id}/
Set payout method
setPayoutMethod 2 params body → 200401404
GET
/affiliates/{affiliate_id}/payout-methods/
List payout methods
listPayoutMethods 1 param → 200401404
PUT
/affiliates/{child_affiliate_id}/parent/
Set parent
setAffiliateParent 1 param body → 200401404
DELETE
/affiliates/{child_affiliate_id}/parent/
Remove parent
removeAffiliateParent 1 param → 200401404
GET
/affiliates/{affiliate_id}/balances/
Retrieve affiliate's balances
getAffiliateBalances 1 param → 200401404
GET
/affiliates/{affiliate_id}/payments/
List affiliate's payments
listAffiliatePayments 3 params → 200401404
GET
/affiliates/{id}/programs/
Get affiliations
getAffiliations 1 param → 200401404
GET
/affiliates/custom-fields/
Get custom fields
getCustomFields → 200401

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Affiliate (10 properties), Affiliation (6 properties), Payment (6 properties), AffiliateRef (4 properties). Each schema is shown below with its type and property counts.

Note
object
3 properties
Affiliate
object
10 properties
AffiliateGroup
object
2 properties
Affiliation
object
An affiliate's enrollment in a program
6 properties
PayoutMethod
object
3 properties
AffiliateRef
object
4 properties
Balance
object
3 properties
Payment
object
6 properties
Error
object
1 property
CustomField
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tapfiliate-affiliates-api-openapi.yml Raw ↑

Other APIs Tapfiliate publishes across the network.

Tapfiliate Affiliate Groups API
Tapfiliate Affiliate Prospects API
Tapfiliate Balances API
Tapfiliate Clicks API
Tapfiliate Commissions API
Tapfiliate Conversions API
Tapfiliate Customers API
Tapfiliate Payments API
Tapfiliate Programs API