Documentation generated
at 04.02.2023 23:29:02

Affiliate

Get a list of official banners
GET public/affiliate/banners
API Token required
curl -X GET \
-G 'https://api.pph.sh/public/affiliate/banners' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": [
        {
            "id": "Dedicated_300x250_Medium-Rectangle-Inline-Rectangle-dark",
            "data": [
                "Affiliate-Banner-Dedicated",
                "300x250",
                "Medium-Rectangle-Inline-Rectangle-dark"
            ],
            "hash": "334c698f89abe0bea83d48338fcdb3fb",
            "name": "Medium Rectangle Inline Rectangle",
            "width": 300,
            "height": 250,
            "category": "dedicated",
            "friendly_name": "[Dedicated] Medium Rectangle Inline Rectangle (300x250, dark)",
            "style": "dark",
            "preview": "https:\/\/api.pph.sh\/public\/affiliate\/banners\/preview\/Dedicated_300x250_Medium-Rectangle-Inline-Rectangle-dark.png"
        }
    ]
}
Get banner html code
GET public/affiliate/banners/code/:partner/:banner
API Token required
curl -X GET \
-G 'https://api.pph.sh/public/affiliate/banners/code/<partner>/<banner>' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": {
        "error": true,
        "type": "ErrorException",
        "url": "https:\/\/fsn-01.api.pph.sh\/public\/affiliate\/banners\/code\/corrupti\/vero",
        "message": "Undefined array key \"category\""
    }
}
Get affiliate details
GET client/affiliate
API Token required

Returns affiliate details. Creates an affiliate account when not yet created.

curl -X GET \
-G 'https://api.pph.sh/client/affiliate' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": {
        "affiliate_id": 41003,
        "enabled": 0,
        "activated": 1,
        "plan": "community",
        "minimum_payout_value": 5,
        "confirmation_window": 15,
        "banner_views": 7,
        "clicks": 39,
        "conversion30": 0,
        "conversions": {
            "confirmed": 10,
            "unconfirmed": 3
        },
        "payout": {
            "type": "credit",
            "unconfirmed": 0.57,
            "available": 8.22,
            "payout_available": false,
            "minimum": 5
        },
        "pending_payout": false,
        "urls": [
            "https:\/\/pph.sh\/partner\/41003"
        ]
    }
}
Get affiliate details
POST client/affiliate/activate
API Token required

Returns affiliate details. Creates an affiliate account when not yet created.

curl -X POST \
-G 'https://api.pph.sh/client/affiliate/activate' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
Check if affiliate account exists.
GET client/affiliate/exists
API Token required
curl -X GET \
-G 'https://api.pph.sh/client/affiliate/exists' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": {
        "exists": true,
        "debug": {
            "e": true,
            "s": 1
        }
    }
}
Get conversions
GET client/affiliate/conversions
API Token required
curl -X GET \
-G 'https://api.pph.sh/client/affiliate/conversions' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": [
        {
            "ordernum": 3771055779,
            "type": "hosting",
            "tier": "tier_1",
            "confirmed": 0,
            "dismissed": 0,
            "paid_out": 0,
            "order_date": "2022-01-31",
            "description": "Bestellung: Linux vServer",
            "payout": null,
            "provision": {
                "full_value": 2.86,
                "affiliate_value": 0.57,
                "percentage": 20,
                "available_at": "2022-02-15"
            }
        }
    ]
}
Get payouts
GET client/affiliate/payouts
API Token required
curl -X GET \
-G 'https://api.pph.sh/client/affiliate/payouts' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": [
        {
            "id": 7,
            "uuid": "adace2ae-627b-4f26-8c87-e920c0ca08c0",
            "value": 11.57,
            "status": "done",
            "review": "done",
            "ticket_id": 975612,
            "type": "credit",
            "invoice_id": 171345,
            "created_at": "2021-10-13T14:05:47.000000Z",
            "conversions_count": 6,
            "partner": {
                "id": 41003,
                "firstname": "Dennis",
                "lastname": "Ziolkowski"
            }
        }
    ],
    "links": {
        "first": "https:\/\/fsn-01.api.pph.sh\/client\/affiliate\/payouts?page=1",
        "last": "https:\/\/fsn-01.api.pph.sh\/client\/affiliate\/payouts?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https:\/\/fsn-01.api.pph.sh\/client\/affiliate\/payouts?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https:\/\/fsn-01.api.pph.sh\/client\/affiliate\/payouts",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}
Get clicks
GET client/affiliate/clicks
API Token required

Response-Params

Feld Datentyp Beschreibung
data[].hash The session id
data[].first_click The first click
data[].last_click The last click
data[].views The number of views
curl -X GET \
-G 'https://api.pph.sh/client/affiliate/clicks' \
-H 'Authorization: Bearer ${ACCESS_TOKEN}' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": [
        {
            "hash": "d23889c2873273e7047d0b232dffa84b",
            "first_click": "2022-01-18T13:37:34.000000Z",
            "last_click": "2022-01-18T13:37:34.000000Z",
            "views": 1
        }
    ]
}
Get default provisions
GET client/affiliate/provisions
curl -X GET \
-G 'https://api.pph.sh/client/affiliate/provisions' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": {
        "webhosting": {
            "group": "webhosting",
            "label": "Webhosting",
            "provision": 30
        },
        "kvm-server": {
            "group": "kvm-server",
            "label": "KVM Server (konfigurierbar)",
            "provision": 25
        },
        "domains": {
            "group": "domains",
            "label": "Domains",
            "provision": 5
        },
        "dedicated": {
            "group": "dedicated",
            "label": "Dedicated Server",
            "provision": 5
        },
        "cloud-server": {
            "group": "cloud-server",
            "label": "Cloud Server (OpenVZ)",
            "provision": 20
        }
    }
}
Get available payout summary
GET client/affiliate/payout/availability
curl -X GET \
-G 'https://api.pph.sh/client/affiliate/payout/availability' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq
{
    "data": {
        "type": "credit",
        "unconfirmed": 0.57,
        "available": 8.22,
        "payout_available": false,
        "minimum": 5
    }
}
Request a payout
POST client/affiliate/payout/request
curl -X POST \
-G 'https://api.pph.sh/client/affiliate/payout/request' \
-H 'Content-Type=application/json' \
-H 'Accept=application/json' \
-H 'Accept-Language=de; *;q=0.5' | jq