ProxyLite OpenAPI

Den app_key Authentifizierungsschlüssel finden Sie nach dem Login auf der Startseite Ihres persönlichen Bereichs.

Bitte bewahren Sie den Schlüssel sicher auf, da er über Administratorrechte für Ihr Konto verfügt.

Basis-URLs:

https://api.proxylite.com

Authentifizierungsmethoden

App Key Authentifizierung

POST-Parameter:

app_key: {your_app_key}

Oder als Query-Parameter:

?app_key={your_app_key}

Antwortformat

Alle Schnittstellen geben ein einheitliches JSON-Format zurück:

{
	"code": 200,
	"message": "Operation erfolgreich",
	"data": {}
}

code: Statuscode, 200 bedeutet Erfolg, andere Werte bedeuten Fehler
message: Antwortnachricht (Chinesisch)
data: Antwortdaten

Authentication

Diese Schnittstelle unterstützt die folgenden zwei Authentifizierungsmethoden:

1. Bearer Token (JWT)

Token wird über HTTP-Header übertragen.

Header-Beispiel:

Authorization: Bearer <your_jwt_token>

API Key Authentifizierung

Diese Schnittstelle verwendet die API Key Methode zur Identitätsüberprüfung.

Der Client muss den app_key Parameter in der Anfrage mitführen, andernfalls wird die Anfrage abgelehnt.

Beispiel:

GET /api/example?app_key=your_app_key

POST /api/example?app_key=your_app_key
Content-Type: application/json

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	responseCode	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig
» msg	string	false	none	Statusnachricht
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	Kontonummer
»»» username	string	false	none	Proxy-Kontoname
»»» password	string	false	none	Proxy-Kontopasswort
»»» created_at	string	false	none	Hinzufügungszeitpunkt
»»» remark	string	false	none	Bemerkung
»»» product_type	productTypes	false	none	Pakettyp, 9 Dynamisches Wohn-Traffic-Paket, 11 Dynamische Wohn-IP, 14 Statische Rechenzentrum-IP, 25 Statische Wohn-IP
»»» usage_flow	integer	false	none	Verbrauchter Traffic, Einheit: KB
»»» limit_flow	integer	false	none	Benutzerdefiniertes Traffic-Limit: Einheit GB, maximal 102400, 0 unbegrenzt
»»» status	integer	false	none	Aktivierungsstatus: 1 aktiviert, 0 deaktiviert

Eigenschaft	Wert
» product_type	9
» product_type	11
» product_type	14
» product_type	25

Bitte beachten Sie, dass nach dem Löschen keine Wiederherstellung möglich ist und verbrauchter Traffic nicht mehr abgefragt werden kann. Die Löschung dauert ca. 5 Minuten, während dieser Zeit können weiterhin Gebühren anfallen.

Body-Anfrageparameter

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
body	body	object	Nein	none
» app_key	body	string	Nein	Autorisierungsschlüssel
» accounts	body	string	Nein	Proxy-Konten, nur Zahlen und Buchstaben. Unterstützt Massenoperationen, getrennt durch Komma (,)

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	null	false	none	none

POST Proxy-Konto deaktivieren

POST /end-point/whitelist-account/disable

Die Deaktivierung dauert ca. 5 Minuten, während dieser Zeit können weiterhin Gebühren anfallen.

Body-Anfrageparameter

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
body	body	object	Nein	none
» app_key	body	string	Nein	Autorisierungsschlüssel
» accounts	body	string	Nein	Proxy-Konten, nur Zahlen und Buchstaben. Unterstützt Massenoperationen, getrennt durch Komma (,)

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	null	false	none	none

POST Proxy-Konto aktivieren

POST /end-point/whitelist-account/enable

Body-Anfrageparameter

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
body	body	object	Nein	none
» app_key	body	string	Nein	Autorisierungsschlüssel
» accounts	body	string	Nein	Proxy-Konten, nur Zahlen und Buchstaben. Unterstützt Massenoperationen, getrennt durch Komma (,)

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	null	false	none	none

POST Proxy-Kontopasswort ändern

POST /end-point/whitelist-account/change-password

Bitte beachten Sie, dass nach der Änderung eine Wartezeit von 5 Minuten besteht, während dieser Zeit kann das alte Passwort noch funktionieren.

Body-Anfrageparameter

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"password": "pass"
}

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
body	body	object	Nein	none
» app_key	body	string	Nein	Autorisierungsschlüssel
» account	body	string	Nein	Proxy-Konto, nur Zahlen und Buchstaben.
» password	body	string	Nein	Neues Proxy-Kontopasswort, nur Zahlen und Buchstaben.

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	null	false	none	none

POST Proxy-Kontobemerkung ändern

POST /end-point/whitelist-account/change-remark

Body-Anfrageparameter

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"remark": ""
}

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
body	body	object	Nein	none
» app_key	body	string	Nein	Autorisierungsschlüssel
» account	body	string	Nein	Proxy-Konto, nur Zahlen und Buchstaben.
» remark	body	string	Nein	Neue Proxy-Kontobemerkung, maximal 32 chinesische oder 64 englische Zeichen.

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	null	false	none	none

POST Proxy-Konto Traffic-Limit ändern

POST /end-point/whitelist-account/change-limit

Bitte beachten Sie, dass die Traffic-Statistik eine Verzögerung von bis zu 5 Minuten haben kann, d.h. der tatsächliche Verbrauch kann dieses Limit überschreiten.

Body-Anfrageparameter

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"limit": 0
}

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
body	body	object	Nein	none
» app_key	body	string	Nein	Autorisierungsschlüssel
» account	body	string	Nein	Proxy-Konto, nur Zahlen und Buchstaben.
» limit	body	integer	Nein	Traffic-Limit, Einheit: GB, 0 für kein Limit

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	null	false	none	none

Traffic-Protokollabfrage

GET Traffic-Nutzung nach Tag zusammengefasst

GET /end-point/user-usage-flow/total

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
app_key	query	string(password)	Ja	Authentifizierungsschlüssel
start_time	query	string(Y-m-d H:i:s)	Nein	Startzeit, kann auf Sekunden genau sein. Bitte beachten Sie, dass die Protokollierung eine Verzögerung von bis zu 5 Minuten haben kann. Standard: innerhalb von 7 Tagen.
end_time	query	string(Y-m-d H:i:s)	Nein	Endzeit, kann auf Sekunden genau sein. Bitte beachten Sie, dass die Protokollierung eine Verzögerung von bis zu 5 Minuten haben kann. Standard: aktuelle Zeit.
username	query	string	Nein	Unterkonto-Name, standardmäßig werden alle Konten abgefragt, kann auf Unterkonto festgelegt werden. Bitte beachten Sie, dass bei gleichnamigen Unterkonten alle Nutzungsaufzeichnungen dieser Proxy-Konten zurückgegeben werden.
product_type	query	number	Nein	Pakettyp

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"day": "2022-08-01",
				"flow": 0
			}
		]
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	object	false	none	none
»» list	[object]	false	none	none
»»» day	string	false	none	Datum
»»» flow	integer	false	none	Verbrauchter Traffic, Einheit KB

Paketabfrage

GET Liste gekaufter Pakete

GET /end-point/user-product/list

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
app_key	query	string(password)	Ja	Authentifizierungsschlüssel
trade_no	query	string	Nein	Bestellnummer, bitte vollständige Bestellnummer eingeben. Keine Fuzzy-Suche unterstützt.
page	query	number	Nein	Seitennummer, Standard: 1
size	query	number	Nein	Anzahl pro Seite, Standard: 20
product_type	query	number	Nein	Pakettyp

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"id": 0,
				"created_at": "2022-05-13 12:14:15",
				"expired_at": "2022-05-13 12:14:15",
				"product_type": 9,
				"trade_no": "2022051312134339861461465434",
				"order": {
					"created_at": "2022-05-13 12:13:43",
					"pay_at": "2022-05-13 12:13:43",
					"title": "Einstiegsstufe"
				}
			}
		],
		"page": 1,
		"page_size": 20,
		"total_count": 0,
		"total_page": 0
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	Paketnummer
»»» created_at	string	false	none	Paket-Aktivierungszeit
»»» expired_at	string	false	none	Paket-Ablaufzeit, nach Ablauf kann der Traffic nicht mehr verwendet werden.
»»» product_type	productTypes	false	none	Pakettyp, 9 Dynamisches Wohn-Traffic-Paket, 11 Dynamische Wohn-IP, 14 Statische Rechenzentrum-IP, 25 Statische Wohn-IP
»»» trade_no	string	false	none	Bestelltransaktionsnummer
»»» order	object	false	none	none
»»»» created_at	string	false	none	Bestellerstellungszeit
»»»» pay_at	string	false	none	Bestellzahlungszeit
»»»» title	string	false	none	Bestellbeschreibung
»» page	integer	false	none	Aktuelle Seite
»» page_size	integer	false	none	Seitengröße
»» total_count	integer	false	none	Gesamtanzahl der Datensätze
»» total_page	integer	false	none	Gesamtanzahl der Seiten

Aufzählungswerte

Eigenschaft	Wert
product_type	9
product_type	11
product_type	14
product_type	25

IP-Extraktion

GET IP extrahieren

GET /end-point/ip/v3

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
app_key	query	string(password)	Nein	Zugriffsschlüssel
cc	query	string	Nein	Land oder Region
state	query	string	Nein	Bundesland oder Staat
city	query	string	Nein	Stadt
format	query	string	Nein	Abrufformat
lb	query	string	Nein	Trennzeichen, nur für text-Format gültig
num	query	number	Nein	Extraktionsmenge
life	query	number	Nein	Haltezyklus - Minuten
ep	query	string	Nein	Proxy-Netzwerk

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			[
				"150.109.114.72:1140",
				"150.109.114.72:1141",
				"150.109.114.72:1142",
				"150.109.114.72:1143",
				"150.109.114.72:1144",
				"150.109.114.72:1145",
				"150.109.114.72:1146",
				"150.109.114.72:1147",
				"150.109.114.72:1148",
				"150.109.114.72:1149"
			]
		]
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	object	false	none	none
»» list	[any]	false	none	none

GET Städteliste

GET /end-point/ip/dynamic-citys

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "USA",
				"name_en": "United States",
				"continent_code": "NA",
				"country_code": "US",
				"items": [
					{
						"city": null,
						"state": null,
						"continent_code": null,
						"country_code": null
					}
				]
			}
		]
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	object	false	none	none
»» list	[object]	false	none	Liste
»»» name_zh_cn	string	false	none	Länder- oder Regionsname
»»» name_en	string	false	none	Länder- oder Regionsname
»»» continent_code	string	false	none	Kontinentcode
»»» country_code	string	false	none	Länder- oder Regionscode
»»» items	[object]	false	none	Bundesland oder Staat
»»»» city	string	false	none	Stadtname
»»»» state	string	false	none	Bundesland- oder Staatscode
»»»» continent_code	string	false	none	Kontinentcode
»»»» country_code	string	false	none	Länder- oder Regionscode

GET Stadtsuche

GET /end-point/ip/dynamic-citys/search

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
country_code	query	string	Ja	Länder- oder Regionscode
state	query	string	Ja	Staat- oder Bundeslandcode

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": ["string"]
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	object	false	none	none
»» list	[string]	false	none	Liste

GET Staatenliste

GET /end-point/ip/dynamic-states

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "USA",
				"name_en": "United States",
				"continent_code": "NA",
				"country_code": "US",
				"items": [
					{
						"state": null,
						"continent_code": null,
						"country_code": null
					}
				]
			}
		]
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	object	false	none	none
»» list	[object]	false	none	Liste
»»» name_zh_cn	string	false	none	Länder- oder Regionsname
»»» name_en	string	false	none	Länder- oder Regionsname
»»» continent_code	string	false	none	Kontinentcode
»»» country_code	string	false	none	Länder- oder Regionscode
»»» items	[object]	false	none	Bundesland oder Staat
»»»» state	string	false	none	Bundesland- oder Staatscode
»»»» continent_code	string	false	none	Kontinentcode
»»»» country_code	string	false	none	Länder- oder Regionscode

GET Staat/Bundesland-Suche

GET /end-point/ip/dynamic-states/search

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
country_code	query	string	Ja	Länder- oder Regionscode

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": ["string"]
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Anfrage erfolgreich	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	object	false	none	none
»» list	[string]	false	none	Liste

GET Liste gekaufter statischer IPs extrahieren

GET /end-point/ip/get-static-ip

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
country_code	query	string	Nein	Länder- oder Regionscode
product_type	query	number	Nein	Produkttyp, 25: Statische Wohn-IP, 14: Rechenzentrum-IP
trade_no	query	string	Nein	IP nach Bestellnummer filtern
page	query	number	Nein	Seitennummer
size	query	number	Nein	Anzahl pro Seite
status	query	number	Nein	Status, 1: Gültig, 2: Ungültig, 3: Läuft bald ab, 4: In Wartung

Aufzählungswerte

Eigenschaft	Wert
product_type	14
product_type	25
status	1
status	2
status	3
status	4

Antwortbeispiel

200 Response

{}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	none	Inline

Rückgabedatenstruktur

GET Verfügbare statische IP-Anzahl nach Region abrufen

GET /end-point/static-ip-region

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
isp	query	string	Nein	IP-Typ

IP-Typ-Beschreibung

IP-Typ	Beschreibung
1	Statische Wohn-IP
0	Statische Rechenzentrum-IP

Antwortbeispiel

200 Response

{
	"code": 200,
	"msg": "Anfrage erfolgreich",
	"data": {
		"list": [
			{
				"code": "US",
				"number": 55
			}
		]
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	none	Inline

Rückgabedatenstruktur

Statuscode 200

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg
» msg	string	false	none	Statusnachricht
» data	object	false	none	none
»» list	[object]	false	none	none
»»» code	string	false	none	Länder- oder Regionscode
»»» number	integer	false	none	Anzahl

Bestellverwaltung

GET Bestellliste

GET /end-point/order/list

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
page_no	query	integer	Nein	none
page_size	query	integer	Nein	none
trade_no	query	string	Nein	Bestellnummer
status	query	integer	Nein	Bestellstatus
product_type	query	integer	Nein	Produkttyp

Detaillierte Beschreibung

status: Bestellstatus

Status	Beschreibung
0	Zahlung ausstehend
1	Bezahlt
2	Timeout, unbezahlt, storniert
3	Erstattet

product_type: Produkttyp

Produkttyp	Beschreibung
3	Guthaben-Aufladung
9	Dynamisches Traffic-Paket
11	Dynamisches globales Zeitpaket V2
12	Langzeit-IDC-Traffic-Paket
13	Statisches Wohn-IP-Traffic-Paket
14	Statisches Rechenzentrum-IP-Paket
15	Langzeit-ISP-Traffic-Paket
16	Statisches Traffic-Paket
17	Dynamisches IP-Anzahl-Paket
18	web-scraper
19	Statische IP-Verlängerung
20	Statische IP-Wechselkontingent
21	Statisches Traffic-Paket v2
24	Statisches Traffic-Zusatzpaket
25	Statisches Wohn-IP-Paket
26	Nachzahlung - Einige Zahlungskanäle erfordern manuelle Betragsangabe, z.B. Kryptowährung. Bei Fehlbeträgen muss der Kundendienst kontaktiert werden
27	Serp
28	Video

Aufzählungswerte

Eigenschaft	Wert
status	0
status	1
status	2
status	3
product_type	3
product_type	9
product_type	11
product_type	12
product_type	14
product_type	16
product_type	17
product_type	18
product_type	19
product_type	21
product_type	24
product_type	25
product_type	26
product_type	27
product_type	28

Antwortbeispiel

200 Response

{
	"code": 0,
	"message": "Operation erfolgreich",
	"data": {
		"list": [
			{
				"id": 0,
				"trade_no": "string",
				"product_id": 0,
				"product_name": "string",
				"total_fee": 0.1,
				"pay_fee": 0.1,
				"status": 0,
				"created_at": "2019-08-24T14:15:22Z"
			}
		],
		"pagination": {
			"total": 0,
			"page_no": 0,
			"page_size": 0,
			"total_pages": 0
		}
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Erfolg	Inline

{
	"pid": x, // Vom Kundendienst erhalten
	"upids": "1,2,3,4,5,6", // Entsprechende ID von /end-point/ip/get-static-ip abrufen
	"pm_id": 1 // Von /end-point/payment/list abrufen
	"coupon_sn: "xxx", // Optional - Gutschein
  }

Body-Anfrageparameter

{
	"pid": 0,
	"upids": "string",
	"amount": 0,
	"pm_id": 0,
	"region_list": "string",
	"coupon_sn": "string",
	"use_invitation_registration_discount": true,
	"renew_duration": 0,
	"product_sku_bandwidth_id": 0,
	"product_sku_concurrency_id": 0,
	"recharge_amount": 0
}

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
body	body	object	Ja	none
» pid	body	integer	Ja	Paket-ID
» upids	body	string	Nein	Verlängerungs-Paket-ID-Liste
» amount	body	number	Nein	Neukauf-Paketanzahl
» pm_id	body	integer	Ja	Zahlungsmethoden-ID
» region_list	body	string	Nein	Region + Anzahl beim Kauf statischer IPs angeben
» coupon_sn	body	string	Nein	Gutscheinnummer
» use_invitation_registration_discount	body	boolean	Nein	Einladungsregistrierungsrabatt verwenden
» renew_duration	body	integer	Nein	Verlängerungsdauer - optional für statische IP
» product_sku_bandwidth_id	body	integer	Nein	Paket 11: Bandbreiten-Paket-ID
» product_sku_concurrency_id	body	integer	Nein	Paket 11: Gleichzeitigkeits-Paket-ID
» recharge_amount	body	integer	Nein	Paket 3: Aufladebetrag

Antwortbeispiel

200 Response

{
	"code": 0,
	"message": "Operation erfolgreich",
	"data": {
		"id": 0,
		"trade_no": "string",
		"product_id": 0,
		"product_name": "string",
		"total_fee": 0.1,
		"pay_fee": 0.1,
		"status": 0,
		"created_at": "2019-08-24T14:15:22Z"
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Erfolgreich erstellt	Inline

Rückgabedatenstruktur

POST Bestellung stornieren

POST /end-point/order/close

Body-Anfrageparameter

{
	"trade_no": "string"
}

Anfrageparameter

Name	Position	Typ	Erforderlich	Beschreibung
body	body	object	Ja	none
» trade_no	body	string	Ja	none

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Operation erfolgreich	None

Benutzerverwaltung

GET Benutzerinformationen abrufen - Noch nicht verfügbar

GET /end-point/user/info

Antwortbeispiel

200 Response

{
	"code": 0,
	"message": "Operation erfolgreich",
	"data": {
		"id": 0,
		"email": "[email protected]",
		"phone": "string",
		"balance": 0.1,
		"status": 0,
		"is_real_name": true,
		"created_at": "2019-08-24T14:15:22Z"
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Erfolg	Inline

Name	Position	Typ	Erforderlich	Beschreibung
trade_no	query	string	Nein	Bestellnummer - kann übergeben werden, wenn spezifische Zahlungsmethoden für bestimmte Bestellungen benötigt werden

Antwortbeispiel

200 Response

{
	"code": 0,
	"message": "Operation erfolgreich",
	"data": {
		"list": [
			{
				"name": "Zahlungsmethoden-Gruppierung",
				"logos": ["https://example.com/logo1.png", "https://example.com/logo2.png"],
				"items": [
					{
						"id": 1,
						"title": "title1",
						"logo": "https://example.com/logo1.png",
						"group": "online",
						"disabled": false,
						"min": 10,
						"max": 5000
					}
				]
			}
		]
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	Erfolgreich abgerufen	Inline

Rückgabedatenstruktur

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	object	false	none	none
»» name	string	false	none	Gruppenname
»» logos	string[]	false	none	Gruppen-Logo-Liste
»» items	object[]	false	none	Elementliste innerhalb der Gruppe
»»» id	integer	false	none	Zahlungsmethoden-ID
»»» title	string	false	none	Zahlungsmethodenname
»»» logo	string	false	none	Zahlungsmethoden-Logo
»»» group	string	false	none	Zahlungsmethoden-Gruppenkennung
»»» disabled	boolean	false	none	Ob deaktiviert (Standard `false`)
»»» min	number	false	none	Mindestbetrag
»»» max	number	false	none	Höchstbetrag

Marketing

GET Aufladebonus-Verhältnis

GET /end-point/activity/balance-recharge-gift-ratio

Aufladebonus-Verhältnis

Antwortbeispiel

200 Response

{
	"code": 0,
	"msg": "Operation erfolgreich",
	"data": {
		"list": [
			{
				"amount": 100,
				"ratio": 1.2
			}
		]
	}
}

Rückgabeergebnis

Statuscode	Statuscode-Bedeutung	Beschreibung	Datenmodell
200	OK	OK	Inline

Rückgabedatenstruktur

Name	Typ	Erforderlich	Einschränkung	Beschreibung
» code	integer	false	none	Statuscode, 200 Erfolg, 3 app_key ungültig, 156 Konto nicht verifiziert
» msg	string	false	none	Statusnachricht
» data	object	false	none	none
» list	[object]	false	none	none
»» amount	integer	false	none	Aufladebetrag
»» ratio	number	false	none	Aufladeverhältnis

Datenstruktur-Beschreibung (Schemas)

productTypes (Pakettyp)

Feld	Typ	Beschreibung
product_type	integer	Pakettyp

Mögliche Werte:

Wert	Bedeutung
9	Dynamisches Wohn-Traffic-Paket
11	Dynamische Wohn-IP
14	Statische Rechenzentrum-IP
25	Statische Wohn-IP

API Key (Authentifizierungsschlüssel)

Wird für die Schnittstellenauthentifizierung verwendet, bitte als Query-Parameter übergeben.

Parametername	Position	Typ	Erforderlich	Beschreibung
app_key	query	string	Ja	Authentifizierungsschlüssel

Allgemeine Antwortfelder

responseCode

Feld	Typ	Beispiel	Beschreibung
code	integer	200	Statuscode (200 Erfolg, 3 bedeutet app_key ungültig)

responseMsg

Feld	Typ	Beispiel	Beschreibung
message	string	success	Antwortnachricht

Erfolgreiche Antwort (SuccessResponse)

{
	"code": 0,
	"message": "Operation erfolgreich",
	"data": {}
}

Fehlerantwort (ErrorResponse)

{
	"code": 400,
	"message": "Parameterfehler",
	"errors": {}
}

User

{
	"id": 0,
	"email": "[email protected]",
	"phone": "string",
	"balance": 0.1,
	"status": 0,
	"is_real_name": true,
	"created_at": "2019-08-24T14:15:22Z"
}

Name	Typ	Erforderlich	Einschränkung	Beschreibung
id	integer	false	none	none
email	string(email)	false	none	none
phone	string	false	none	none
balance	number(float)	false	none	none
status	integer	false	none	none
is_real_name	boolean	false	none	none
created_at	string(date-time)	false	none	none

Order

{
	"id": 0,
	"trade_no": "string",
	"product_id": 0,
	"product_name": "string",
	"total_fee": 0.1,
	"pay_fee": 0.1,
	"status": 0,
	"created_at": "2019-08-24T14:15:22Z"
}

Name	Typ	Erforderlich	Einschränkung	Beschreibung
id	integer	false	none	none
trade_no	string	false	none	none
product_id	integer	false	none	none
product_name	string	false	none	none
total_fee	number(float)	false	none	none
pay_fee	number(float)	false	none	none
status	integer	false	none	none
created_at	string(date-time)	false	none	none

Product

{
	"id": 0,
	"name": "string",
	"type": 0,
	"price": 0.1,
	"description": "string"
}

Name	Typ	Erforderlich	Einschränkung	Beschreibung
id	integer	false	none	none
name	string	false	none	none
type	integer	false	none	none
price	number(float)	false	none	none
description	string	false	none	none

WhiteIp

{
	"id": 0,
	"ip": "string",
	"remark": "string",
	"created_at": "2019-08-24T14:15:22Z"
}

Name	Typ	Erforderlich	Einschränkung	Beschreibung
id	integer	false	none	none
ip	string	false	none	none
remark	string	false	none	none
created_at	string(date-time)	false	none	none

WhitelistAccount

{
	"id": 0,
	"username": "string",
	"limit": 0,
	"used": 0,
	"status": 0
}

Name	Typ	Erforderlich	Einschränkung	Beschreibung
id	integer	false	none	none
username	string	false	none	none
limit	integer	false	none	none
used	integer	false	none	none
status	integer	false	none	none

Coupon

{
	"id": 0,
	"name": "string",
	"code": "string",
	"discount": 0.1,
	"expire_time": "2019-08-24T14:15:22Z"
}

Name	Typ	Erforderlich	Einschränkung	Beschreibung
id	integer	false	none	none
name	string	false	none	none
code	string	false	none	none
discount	number(float)	false	none	none
expire_time	string(date-time)	false	none	none

Article

{
	"id": 0,
	"title": "string",
	"content": "string",
	"created_at": "2019-08-24T14:15:22Z"
}

Name	Typ	Erforderlich	Einschränkung	Beschreibung
id	integer	false	none	none
title	string	false	none	none
content	string	false	none	none
created_at	string(date-time)	false	none	none

Pagination

{
	"total": 0,
	"page_no": 0,
	"page_size": 0,
	"total_pages": 0
}

Name	Typ	Erforderlich	Einschränkung	Beschreibung
total	integer	false	none	none
page_no	integer	false	none	none
page_size	integer	false	none	none
total_pages	integer	false	none	none