Getting Started

Get started with the Affelios Platform API

Let's get you set up with the Affelios Platform API so you can interact with the Affelios system programmatically.

Get your API key

Your API requests are authenticated using an API key sent in the X-Api-Key HTTP Header:

-H 'X-Api-Key: YOUR_API_KEY'

Any request sent to an endpoint that requires Authorization and doesn't include an X-Api-Key will return a 401 (Unauthorized) error.

You can generate an API key from your Dashboard at any time by navigating to Settings > API Keys

Once created click Copy to Clipboard and store the key somewhere safe ensuring that it is not exposed.

Important note: Do NOT store your API Key in any client-side or accessible code and ensure you only set permissions that are specifically required for the use case needed. Permission modules can be added or removed at any time, however, the API Key itself will only be accessible at the point of creation.

Make your first request

To make your first request, send an authenticated request to the customer endpoint using an External Customer Id and a Click Id.

Creates a new customer item.

POST/api/v1/customer

Header parameters

Body

application/jsontext/jsonapplication/*+json

The new customer item body.

brandIdnullable string

externalIdnullable string

externalBrandIdnullable string

clickIdnullable string

usernamenullable string

registrationDatestring (date-time)

countrynullable string

country_codenullable string

revShareExcludednullable boolean

cpaExcludednullable boolean

Response

200

Success

Body

text/plainapplication/jsontext/json

idnullable string

operatorIdnullable string

updatedTsstring (date-time)

createdTsnullable string (date-time)

isIdEmptyboolean

createdBynullable string

importIdnullable string

externalIdnullable string

externalBrandIdnullable string

usernamenullable string

countrynullable string

country_codenullable string

registerIpnullable string

referringUrlnullable string

registrationDatestring (date-time)

hasDepositedboolean

ftdDatestring (date-time)

cpaQualifiedboolean

cpaQualificationDatestring (date-time)

lifetimeRevenuenumber (double)

firstDepositAmountnullable number (double)

lifetimeDepositsnullable number (double)

lifetimeCommissionnumber (double)

trackingnullable all of

categorynullable string

labelnullable string

revShareExcludedboolean

cpaExcludedboolean

transactionsnullable array of Transaction (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/customer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "operatorId": "text",
  "updatedTs": "2024-11-06T23:34:45.699Z",
  "createdTs": "2024-11-06T23:34:45.699Z",
  "isIdEmpty": false,
  "createdBy": "text",
  "importId": "text",
  "externalId": "text",
  "externalBrandId": "text",
  "username": "text",
  "country": "text",
  "country_code": "text",
  "registerIp": "text",
  "referringUrl": "text",
  "registrationDate": "2024-11-06T23:34:45.699Z",
  "hasDeposited": false,
  "ftdDate": "2024-11-06T23:34:45.699Z",
  "cpaQualified": false,
  "cpaQualificationDate": "2024-11-06T23:34:45.699Z",
  "lifetimeRevenue": 0,
  "firstDepositAmount": 0,
  "lifetimeDeposits": 0,
  "lifetimeCommission": 0,
  "tracking": {
    "clickId": "text",
    "affiliateId": "text",
    "affiliateName": "text",
    "campaignId": "text",
    "campaignName": "text",
    "brandId": "text",
    "brandName": "text",
    "productId": "text",
    "productName": "text",
    "mediaId": "text",
    "media": {
      "type": "text",
      "text": "text",
      "imageUrl": "text"
    },
    "customParameter": "text",
    "date": "2024-11-06T23:34:45.699Z",
    "referringUrl": "text"
  },
  "category": "text",
  "label": "text",
  "revShareExcluded": false,
  "cpaExcluded": false,
  "transactions": [
    {
      "id": "text",
      "operatorId": "text",
      "updatedTs": "2024-11-06T23:34:45.699Z",
      "createdTs": "2024-11-06T23:34:45.699Z",
      "isIdEmpty": false,
      "createdBy": "text",
      "importId": "text",
      "integrationType": "text",
      "customerId": "text",
      "type": "text",
      "externalId": "text",
      "externalCustomerId": "text",
      "externalBrandId": "text",
      "externalProductId": "text",
      "country": "text",
      "country_code": "text",
      "depositAmount": 0,
      "firstTransaction": false,
      "grossRevenue": 0,
      "revenueAmount": 0,
      "wageredAmount": 0,
      "taxes": 0,
      "costOfGoodsSold": 0,
      "paymentFees": 0,
      "cpaQualified": false,
      "revShareCommission": 0,
      "cpaCommission": 0,
      "adjustmentAmount": 0,
      "totalCommission": 0,
      "transactionDate": "2024-11-06T23:34:45.699Z",
      "tracking": {
        "clickId": "text",
        "affiliateId": "text",
        "affiliateName": "text",
        "campaignId": "text",
        "campaignName": "text",
        "brandId": "text",
        "brandName": "text",
        "productId": "text",
        "productName": "text",
        "mediaId": "text",
        "media": {
          "type": "text",
          "text": "text",
          "imageUrl": "text"
        },
        "customParameter": "text",
        "date": "2024-11-06T23:34:45.699Z",
        "referringUrl": "text"
      },
      "category": "text",
      "label": "text",
      "note": "text",
      "childAffiliateIds": [
        "text"
      ],
      "payoutInfo": {
        "affiliateId": "text",
        "affiliateName": "text",
        "invoicePeriod": "text",
        "invoiceDate": "2024-11-06T23:34:45.699Z",
        "dueDate": "2024-11-06T23:34:45.699Z",
        "payoutMethod": {
          "id": "text",
          "operatorId": "text",
          "updatedTs": "2024-11-06T23:34:45.699Z",
          "createdTs": "2024-11-06T23:34:45.699Z",
          "isIdEmpty": false,
          "createdBy": "text",
          "companyId": "text",
          "companyName": "text",
          "type": "text",
          "payee": "text",
          "walletAddress": "text",
          "email": "text",
          "iban": "text",
          "swift": "text",
          "accountNumber": "text",
          "sortcode": "text",
          "bankName": "text",
          "bankAddress": {
            "addressLine": "text",
            "addressLine2": "text",
            "city": "text",
            "region": "text",
            "country": "text",
            "postcode": "text"
          }
        },
        "paymentDate": "2024-11-06T23:34:45.699Z",
        "amount": 0,
        "tax": 0,
        "total": 0,
        "notes": "text",
        "email": "text",
        "website": "text",
        "affiliateContact": "text",
        "affiliateCompany": "text",
        "affiliateCompanyNo": "text",
        "affiliateAddress": {
          "addressLine": "text",
          "addressLine2": "text",
          "city": "text",
          "region": "text",
          "country": "text",
          "postcode": "text"
        },
        "affiliateTaxIds": [
          {
            "id": "text",
            "value": "text",
            "type": "text",
            "country": "text",
            "stripeId": "text",
            "stripeStatus": "text"
          }
        ],
        "affiliateVatRegistered": false,
        "affiliateTaxRate": 0,
        "companyName": "text",
        "companyInvoiceAddress": {
          "addressLine": "text",
          "addressLine2": "text",
          "city": "text",
          "region": "text",
          "country": "text",
          "postcode": "text"
        },
        "companyTaxIds": [
          {
            "id": "text",
            "value": "text",
            "type": "text",
            "country": "text",
            "stripeId": "text",
            "stripeStatus": "text"
          }
        ],
        "companyNumber": "text",
        "accountsEmail": "text",
        "currencyCode": "text"
      }
    }
  ]
}

Field	Description
ExternalId*	Required. The Customer Id from your system.
ExternalBrandId*	Required. The identifier that you configured in Affelios for the Brand or Shop that this customer registered to.
RegistrationDate*	Required. An ISO-8601 Zulu Timestamp of the date and time when the customer registered in your system.
ClickKey	The ClickKey is generated by Affelios and passed to your website or application. If no ClickKey exists, Affelios will either reject this customer or assign it to an internal Organic Tracking campaign which can be configured in System Settings.

Take a look at a few examples of how you might call this method using curl, Node, or C#:

curl

curl -X POST https://platform.affelios.com/api/v1/customer
  -H 'Content-Type: application/json'
  -H 'X-Api-Key: YOUR_API_KEY'
  -d '{
        "externalId": "YOUR_CUSTOMER_ID",
        "externalBrandId": "YOUR_BRAND_ID",
        "clickKey": "CLICK_KEY",
        "registrationDate": "DATETIME"
      }'

Node

const rp = require('request-promise');

const options = {
  method: 'POST',
  url: 'https://platform.affelios.com/api/v1/customer',
  headers: {
    'Content-Type': 'application/json',
    'X-Api-Key': 'YOUR_API_KEY'
  },
  body: {
    externalId: 'YOUR_CUSTOMER_ID',
    externalBrandId: 'YOUR_BRAND_ID',
    clickKey: 'CLICK_KEY',
    registrationDate: 'DATETIME'
  },
  json: true
};

try {
  const response = await rp(options);
  console.log(response);
} catch (error) {
  console.error(error);
}

C#

using var client = new HttpClient();

var uri = new Uri("https://platform.affelios.com/api/v1/customer");
var json = JsonSerializer.Serialize(new
{
    externalId = "YOUR_CUSTOMER_ID",
    externalBrandId = "YOUR_BRAND_ID",
    clickKey = "CLICK_KEY",
    registrationDate = "DATETIME"
});

using var content = new StringContent(json, System.Text.Encoding.UTF8, "application/json");

client.DefaultRequestHeaders.Add("Content-Type", "application/json");
client.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.PostAsync(uri, content);

if (response.IsSuccessStatusCode)
{
    var responseJson = await response.Content.ReadAsStringAsync();
    var result = JsonSerializer.Deserialize<dynamic>(responseJson);
    Console.WriteLine(result);
}
else
{
    Console.WriteLine("Error: " + response.StatusCode);
}