Für den Zugriff auf die API verwendest Du den API-Token aus Deinem Profil (Profil → Allgemeine Profileinstellungen → API-Token generieren).
Mit der API kannst Du:
- Deine Arbeit mit Catuik optimieren;
- aktuelle Informationen zu Provisionen, Produkten, Deals und Sources abrufen;
- die Bewerbung von Produkten effizient verwalten und Deine Einnahmen steigern.
So funktioniert die API
Du sendest von Deinem Server eine HTTP-GET-Anfrage an unsere API, um die benötigten Informationen aus Deinem Account abzurufen. Wir empfangen und verarbeiten die Anfrage und senden anschließend eine Antwort im JSON-Format an Deinen Server. Zur Authentifizierung muss die Anfrage den eindeutigen Token aus Deinem Profil enthalten.
Request-Methoden
Bei den Requests Get products list with links, Get promotions list und Get promotion products musst Du die ID Deiner Source angeben. Die Source-ID erhältst Du über den API-Request Get source list.
Get commissions list
Gibt Informationen zu Provisionen zurück.
Request-URL – https://api.catuik.com/v2/publisher/commission/
Request-Parameter
| Name | Zulässiger Wert |
|---|---|
| id | ID der Provision |
| subid | Beliebige Kennung, die Du zur zusätzlichen Kategorisierung und zum Tracking von Traffic verwenden kannst |
| status |
Status der Provision: pending – ausstehend approved – bestätigt declined – abgelehnt |
| payment_type |
Vergütungsmodell: cpa – Vergütung pro Bestellung cpc – Vergütung pro Klick unter Berücksichtigung der Verkäufe (verkaufsabhängiger CPC) cpmc – Vergütung pro Klick von der Storefront zum Produkt (Storefront-CPC); hcpa – Vergütung für Verkäufe plus Fixbonus nach Erreichen des Klick-Schwellenwerts (hybride CPA) |
| created_at_from | Erstellungsdatum der Provision: Periodenbeginn |
| created_at_to | Erstellungsdatum der Provision: Periodenende |
| updated_at_from | Datum der Statusaktualisierung der Provision: Periodenbeginn |
| updated_at_to | Datum der Statusaktualisierung der Provision: Periodenende |
| page | Seitennummer |
| limit | Anzahl der Einträge pro Seite (Standard: 50; zulässiger Bereich: 1 bis 1.000) |
Beispielanfrage mit curl -H "Host: api.catuik.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.catuik.com/v2/publisher/commission/?... \ --compressed
Beispielantwort des API-Servers im JSON-Format
{
"total_count": 1000,
"page": 1,
"limit": 50,
"items": [
{
"id": "string",
"payment_type": "cpa",
"status": "pending",
"commission_date": "2021-01-01",
"source": {
"id": 0,
"title": "string",
"status": "verification",
"source_type": {
"id": 0,
"type": "social_network",
"title": "string",
"slug": "string"
},
"source_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"order_product": {
"id": 0,
"title": "string",
"sku": "string"
},
"click_product": {
"id": 0,
"title": "string",
"sku": "string"
},
"subid": "string",
"marketplace": "AliExpress",
"commission_amount": 0.1,
"cart_amount": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
Felder der API-Antwort für Get commissions list
| Feld | Beschreibung |
|---|---|
| id | Eindeutige Kennung der Provision |
| payment_type | Vergütungsmodell der Provision |
| status | Aktueller Status der Provision |
| commission_date | Registrierungsdatum der Provision |
| source | Source |
| order_product | Informationen zum bestellten Produkt, falls vorhanden |
| click_product | Produkt, auf das der Klick erfolgte, der zur Bestellung führte |
| subid | Zusätzliche Kennung zum Tracking der Traffic-Quelle, falls Du sie beim Erstellen des Links angegeben hast |
| marketplace | Name des Marktplatzes |
| commission_amount | Höhe der Provision |
| cart_amount | Bestellwert |
| created_at | Datum und Uhrzeit der Bestellung |
| updated_at | Datum und Uhrzeit der letzten Aktualisierung des Bestellstatus |
Get products list with links
Gibt Informationen zu Produkten mit Affiliate-Links zurück.
Request-URL – https://api.catuik.com/v2/publisher/product/
Request-Parameter
| Name | Zulässiger Wert |
|---|---|
| source_id | Source-ID (die ID Deiner Source erhältst Du über den API-Request Get source list) |
| subid | Beliebige Kennung, die Du zur zusätzlichen Kategorisierung und zum Tracking von Traffic verwenden kannst. |
| marketplace | Name des Marktplatzes: „AliExpress“ |
| category_id | Numerische ID der Produktkategorie (um einen numerischen Code dem Namen einer Produktkategorie zuzuordnen, verwende den Request Get product categories list) |
| favorite | Favoriten (ein Produkt kannst Du nur in Deinem Account zu „Favoriten“ hinzufügen oder daraus entfernen) |
| payment_type |
Vergütungsmodell: cpa – Vergütung pro Bestellung cpc – Vergütung pro Klick unter Berücksichtigung der Verkäufe (verkaufsabhängiger CPC) cpmc – Vergütung pro Klick von der Storefront zum Produkt (Storefront-CPC); hcpa – Vergütung für Verkäufe plus Fixbonus nach Erreichen des Klick-Schwellenwerts (hybride CPA) |
| page | Seitennummer |
| limit | Anzahl der Einträge pro Seite (Standard: 50; zulässiger Bereich: 1 bis 1.000) |
Beispielanfrage mit curl -H "Host: api.catuik.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.catuik.com/v2/publisher/product/?sou... \ --compressed
Beispielantwort des API-Servers im JSON-Format
{
"total_count": 1000,
"page": 1,
"limit": 50,
"items": [
{
"id": "string",
"product_id": 0,
"title": "string",
"image_url": "string",
"price": 0.1,
"commission": 0.1,
"product_category": "string",
"marketplace_title": "string",
"store_title": "string",
"external_link": "string",
"favorite": true,
"payment_type": "cpa",
"tracking_link": "string",
"legal_text": "string"
}
]
}
Felder der API-Antwort für Get products list with links
| Feld | Beschreibung |
|---|---|
| id | Eindeutige Produktkennung |
| product_id | Eindeutige Produktkennung auf dem Marktplatz |
| product_sku | Eindeutige Produktkennung – SKU (Artikelnummer des Herstellers) |
| title | Produktname |
| image_url | Link zum Bild |
| price | Produktpreis |
| commission | Provision für die Bewerbung |
| product_category | Produktkategorie (um Namen von Produktkategorien ihren numerischen Codes zuzuordnen, verwende den Request Get product categories list) |
| marketplace_title | Name des Marktplatzes |
| store_title | Name des Shops |
| external_link | Direkter Link zum Produkt auf dem Marktplatz |
| favorite | Favoriten |
| payment_type | Vergütungsmodell |
| tracking_link | Affiliate-Link zum Produkt |
Get product categories list
Gibt Informationen zu Produktkategorien für die Bewerbung zurück.
Request-URL – https://catuik.com/v2/publisher/product-category/
Produktkategorien werden durch Zahlen oder Namen angegeben. Mit Get product categories list kannst Du einen numerischen Kategoriecode dem entsprechenden Namen zuordnen.
Request-Parameter
| Name | Zulässiger Wert |
|---|---|
| product-category | Produktkategorie |
Beispielanfrage mit curl -H "Host: api.catuik.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.catuik.com/v2/publisher/product-cate... \ --compressed
Beispielantwort des API-Servers im JSON-Format
{
"items": [
{
"id": 0,
"title": "string"
}
]
}
Felder der API-Antwort für Get product categories list
| Feld | Beschreibung |
|---|---|
| id | Eindeutige Kennung der Kategorie |
| title | Name der Produktkategorie |
Get promotions list
Gibt Informationen zu aktiven Deals und Promo-Codes zurück.
Request-URL – https://api.catuik.com/v2/publisher/promotion/
Request-Parameter
| Name | Zulässiger Wert |
|---|---|
| source_id | Source-ID (die ID Deiner Source erhältst Du über den API-Request Get source list) |
| promotion_id | ID des Deals/Promo-Codes |
| marketplace | Name des Marktplatzes: „AliExpress“ |
| promotion_type |
Typ des Deals/Promo-Codes: global_sale – globale Deals und Sales des Marktplatzes sale – Deals von Verkäufern coupon – Promo-Codes von Verkäufern |
| favorite | Favoriten (ein Produkt kannst Du nur in Deinem Account zu „Favoriten“ hinzufügen oder daraus entfernen) |
| page | Seitennummer |
| limit | Anzahl der Einträge pro Seite (Standard: 50; zulässiger Bereich: 1 bis 1.000) |
Beispielanfrage mit curl -H "Host: api.catuik.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.catuik.com/v2/publisher/promotion/?s... \ --compressed
Beispielantwort des API-Servers im JSON-Format
{
"total_count": 1000,
"page": 1,
"limit": 50,
"items": [
{
"id": 0,
"title": "string",
"promotion_type": "global_sale",
"marketplace_title": "string",
"store_title": "string",
"discount_type": "fixed",
"discount_value": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"coupon": "string",
"landing_link": "string",
"legal_text": "string"
}
]
}
Get promotion products
Gibt Informationen zu Produkten in Deals zurück.
Request-URL – https://api.catuik.com/v2/publisher/promotion/product/
Request-Parameter
| Name | Zulässiger Wert |
|---|---|
| source_id | Source-ID (die ID Deiner Source erhältst Du über den API-Request Get source list) |
| subid | Beliebige Kennung, die Du zur zusätzlichen Kategorisierung und zum Tracking von Traffic verwenden kannst. |
| marketplace | Name des Marktplatzes: „AliExpress“ |
| category_id | ID der Produktkategorie (um einen numerischen Code dem Namen einer Produktkategorie zuzuordnen, verwende den Request Get product categories list) |
| favorite | Favoriten (ein Produkt kannst Du nur in Deinem Account zu „Favoriten“ hinzufügen oder daraus entfernen) |
| promotion_id | ID des Deals/Promo-Codes (Du erhältst sie über den Request Get promotion list) |
| page | Seitennummer |
| limit | Anzahl der Einträge pro Seite (Standard: 50; zulässiger Bereich: 1 bis 1.000) |
Beispielanfrage mit curl -H "Host: api.catuik.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.catuik.com/v2/publisher/promotion/pr... \ --compressed
Beispielantwort des API-Servers im JSON-Format
{
"total_count": 1000,
"page": 1,
"limit": 50,
"items": [
{
"id": "string",
"product_id": 0,
"title": "string",
"image_url": "string",
"price": 0.1,
"price_discount": 0.1,
"discount_percent": 0.1,
"commission": 0.1,
"product_category": "string",
"marketplace_title": "string",
"store_title": "string",
"promotion_id": 0,
"favorite": true,
"tracking_link": "string",
"legal_text": "string"
}
]
}
Get source list
Gibt Informationen zu Sources und deren Status zurück.
Request-URL – https://api.catuik.com/v2/publisher/source/
Die in der Antwort zurückgegebene Source-ID wird in folgenden API-Requests verwendet: Get products list with links, Get promotions list und Get promotion products.
Request-Parameter
| Name | Zulässiger Wert |
|---|---|
| status | Status der Source: verification – in Prüfung; approved – verifiziert; declined – abgelehnt |
Beispielanfrage mit curl -H "Host: api.catuik.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.catuik.com/v2/publisher/source/?stat... \ --compressed
Beispielantwort des API-Servers im JSON-Format
{
"items": [
{
"id": 0,
"title": "string",
"status": "verification",
"source_type": {
"id": 0,
"type": "social_network",
"title": "string",
"slug": "string"
},
"source_url": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}
Felder der API-Antwort für Get source list
| Feld | Beschreibung |
|---|---|
| id | Eindeutige Kennung der Source |
| title | Name der Source |
| status | Status der Source |
| source_type | Typ der Source |
| source_url | Link zur Source |
| created_at | Erstellungsdatum der Source |