NSocks

Unterstützt die Verwaltung von persönlichen Konten, Agentenressourcen und Teamabrechnung über das OpenAPI-Präfix der Website.

Die Authentifizierungsmethode basiert auf der Sicherheitsdefinition der jeweiligen Operation:

• apiKeyAuth: Übergeben Sie Ihren persönlichen API-Schlüssel oder den Ihres Teams, indem Sie den Parameter app_key abfragen; das Backend unterstützt außerdem die Parameter key, appkey, openid und den POST-Anfragetext.
• bearerAuth: Autorisierung: Bearer <JWT> Dies wird für Web-Login-Tokens verwendet. Verwenden Sie den API-Schlüssel nicht als JWT.
• Der Team-API-Schlüssel ist an ein festes Team gebunden; bei Schnittstellen, die Team-Bereiche unterstützen, kann die Team-ID weggelassen werden, aber wenn sie explizit angegeben wird, muss sie mit dem an den Schlüssel gebundenen Team übereinstimmen.
• APIs, die nur persönliche Bereiche unterstützen, lehnen Team-API-Schlüssel ab; Teamoperationen richten sich jedoch weiterhin nach den Ressourcenberechtigungen der jeweiligen Mitglieder.

Die JSON-Antwort enthält Code, Nachricht, Daten und Anfrage-ID. Code=200 bedeutet erfolgreiche Operation; HTTP 200 kann auch einen Fehlercode enthalten. Die Meldung variiert je nach Anforderungssprache; der Client sollte den Code verwenden, um das Ergebnis zu ermitteln. Einige Exportschnittstellen unterstützen auch Text, CSV oder XML; Einzelheiten finden Sie in der Operationsdefinition. Die Felder für Betrag, Durchfluss, Datum und Paginierung unterliegen dem jeweiligen Schnittstellenschema.

Basis-URLs: "https://api.nsocks.com"

Authentifizierung

• HTTP-Authentifizierung, Schema: Bearer

• API-Schlüssel (apiKeyAuth2)
  • Parametername: app_key, in: query. Persönlicher oder Team-API-Schlüssel. Der empfohlene Abfrageparameter ist app_key; er ist auch mit key/appkey/openid und POST-Anfragetexten kompatibel. Team-Schlüssel können nur auf unterstützte, dem Team zugeordnete Schnittstellen zugreifen.

API-Schlüsselverwaltung

GET-API-Schlüsselliste

GET /ep/api-keys

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "id": 1,
        "api_key": "string",
        "team_user_id": 0,
        "remark": "string",
        "status": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "pageSize": 1
  }
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Statuscode 200

Aufzählungswert

API-Schlüssel per POST erstellen

POST /ep/api-keys/create

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "remark": "string"
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "api_key": "string",
    "team_user_id": 0,
    "remark": "string",
    "status": 0,
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

POST API-Schlüssel aktivieren

POST /ep/api-keys/enable

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Anfrageparameter

Ergebnisse zurückgeben

POST-Deaktivierungs-API-Schlüssel

POST /ep/api-keys/disable

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Anfrageparameter

Ergebnisse zurückgeben

POST-Anfrage zum Löschen des API-Schlüssels

POST /ep/api-keys/delete

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Anfrageparameter

Ergebnisse zurückgeben

POST-Anfrage zum Ändern der API-Schlüssel-Bemerkungen

POST /ep/api-keys/update-remark

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

Anfrageparameter

Ergebnisse zurückgeben

Teammanagement

Beitrag: Team erstellen

POST /ep/team/create

Anfrageparameter

{
  "name": "string"
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

Liste der Teams abrufen, auf die der Benutzer aktuell zugreifen kann

GET /ep/team/list

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

Details zum GET-Team

GET /ep/team/detail

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

Beitrag zum Ändern des Teamnamens

POST /ep/team/update-name

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "string"
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

POST löst das Team auf

POST /ep/team/dissolve

Diese Funktion kann nur vom Hauptadministrator des Teams aufgerufen werden. Der Name in der Anfrage muss exakt mit dem aktuellen Teamnamen übereinstimmen. Diese Schnittstelle erzwingt eine sekundäre Verifizierung: Sie gibt den Code 348 zurück, wenn sich der Benutzer nicht in einem 15-minütigen Vertrauenszustand befindet. Der Aufrufer sollte den Verifizierungscode anhand der in den Antwortdaten verfügbaren Methoden ermitteln und es dann mit verify_type und verify_code erneut versuchen. Es kann wiederholt aufgerufen werden, um einen noch nicht abgeschlossenen Auflösungsprozess fortzusetzen.

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "华东研发团队",
  "verify_type": "email",
  "verify_code": "123456"
}

Anfrageparameter

Aufzählungswert

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

GET-Abfrage zum Status der Teamauflösung

GET /ep/team/dissolve-status

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

Teamressourcen

Informationen zum Teampaket anfordern

GET /ep/team/product-info

Gibt eine Zusammenfassung des Pakets für den Ressourcenbereich des angegebenen Teams zurück, wobei die Felder mit den Paketfeldern in /web_v1/user/info übereinstimmen. Das Profil des Team-Superadministrators, sein Guthaben oder seine interne numerische Team-ID werden nicht angezeigt. Details zu Punktepaketen finden Sie unter /web_v1/credit/info.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [0],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

GET-Team-Asset-Liste

GET /ep/team/assets

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Persönliche Vermögenswerte, die in das Team aufgenommen werden können

GET /ep/team/assets/personal-candidates

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

POST Persönliche Vermögensübertragung an Team

POST /ep/team/assets/move-in

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Vermögenswerte des POST-Teams wurden an Einzelpersonen zurückgegeben.

POST /ep/team/assets/move-out

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Team Wallet

GET-Abfrage Team Wallet

GET /ep/team/wallet/detail

Die Berechtigung VIEW_BILLING ist erforderlich. Das Team-Wallet ist von den individuellen Guthaben des Superadministrators und der Mitglieder getrennt.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

GET-Abfrage: Transaktionsverlauf der Team-Wallet

GET /ep/team/wallet/records

Die Berechtigung VIEW_BILLING ist erforderlich. Transaktionsbeträge sind immer positiv, und Änderungen der Geldbeträge werden durch das Richtungsfeld angezeigt.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

Persönliches Guthaben auf Team-Wallet übertragen

POST /ep/team/wallet/transfer-in

Nur Team-Superadministratoren besitzen die Berechtigung TRANSFER_BALANCE. Geldtransfers werden automatisch vom persönlichen Guthaben des Teams abgezogen und dem Team-Guthaben gutgeschrieben. Der transferierte Betrag ist nicht in der Gesamtaufladegebühr enthalten und kann nicht zurücküberwiesen werden.

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 0
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

POST-Teamguthaben auf das persönliche Konto zurücküberwiesen

POST /ep/team/wallet/transfer-out

Diese Funktion kann nur von einem angemeldeten Administrator aufgerufen werden. Sie bucht den Betrag atomar vom Team-Guthaben ab und erhöht das Guthaben des jeweiligen Nutzers; der Gesamtbetrag des Teams oder des einzelnen Nutzers bleibt unverändert. Sie kann verwendet werden, um Guthaben von aufgelösten Teams zurückzufordern, jedoch nicht von aufgelösten Teams selbst.

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 0
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Teammitglieder

GET-Teammitgliederliste

GET /ep/team/members

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

Einheitliche Liste der GET-Teammitglieder

GET /ep/team/people

Gibt gültige Mitglieder zurück; Superadministratoren und Administratoren sehen außerdem ausstehende Einladungen. Andere Einladungsstatus werden nur in der Einladungshistorie gespeichert.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

POST: Anpassung der Mitgliedsrollen

POST /ep/team/members/update-role

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1,
  "role": 2
}

Anfrageparameter

Aufzählungswert

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

POST Teammitglied entfernen

POST /ep/team/members/remove

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

POST - Team verlassen

POST /ep/team/members/leave

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6"
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

Teameinladung

POST Team-Einladung erstellen

POST /ep/team/invitations/create

Einladungen werden anhand registrierter Nutzer, E-Mail-Adressen oder Telefonnummern erstellt. Wenn eine E-Mail-Adresse oder Telefonnummer mit einem Nutzer auf dieser Website übereinstimmt, wird die Antwort auf invite_type=1 normalisiert. Das Frontend kann eine Vorlage für einen relativen Pfad der Einladungs-URL von dieser Website übermitteln, und der Server ersetzt dann einfach durch ein einmaliges Einladungstoken. Wenn sich ein nicht registrierter Nutzer mit der eingeladenen Mobilnummer registriert oder die Verifizierung mit der eingeladenen E-Mail-Adresse abschließt, verknüpft der Server die noch gültige Einladung mit dem neuen Nutzer, rotiert das Token und sendet lediglich eine ungelesene In-App-Nachricht erneut. Das alte Token in der ursprünglichen E-Mail oder SMS wird dadurch ungültig. Falls die E-Mail-Einladung noch nicht automatisch verknüpft wurde, kann das mit der eingeladenen E-Mail-Adresse registrierte Konto sie direkt empfangen, ohne auf die E-Mail-Verifizierung warten zu müssen.

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "invite_type": 1,
  "role": 2,
  "user_id": 1,
  "email": "user@example.com",
  "country_code": 1,
  "phone": "string",
  "invitation_url_template": "/team/invitation/{{token}}"
}

Anfrageparameter

Aufzählungswert

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": null,
      "team_id": null,
      "inviter_user_id": null,
      "invitee_user_id": null,
      "invite_type": null,
      "invite_country_code": null,
      "invite_target": null,
      "delivery_type": null,
      "role": null,
      "status": null,
      "accepted_by_user_id": null,
      "expired_at": null,
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": null
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": null,
      "sms": null,
      "site_inner_message": null
    }
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

GET-Team-Einladungsliste

GET /ep/team/invitations

Der Zugriff ist nur für Team-Superadministratoren oder Administratoren möglich; abgelaufene, ausstehende Einladungen werden vor ihrer Rückgabe auf „abgelaufen“ aktualisiert.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

Einladung für das GET Preview-Team

GET /ep/team/invitations/preview

Anonyme Vorschau-Einladungen werden mithilfe eines einmaligen Einladungstokens versendet; die numerische Einladungs-ID wird im Link nicht verwendet.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

POST Team-Einladungsbenachrichtigung erneut senden

POST /ep/team/invitations/resend

Senden Sie die Einladung erneut über den ursprünglichen Kanal; registrierte Nutzer erhalten zusätzlich eine In-App-Nachricht. Durch das erneute Senden werden die Tokens rotiert, und alle vorherigen Einladungslinks verlieren sofort ihre Gültigkeit.

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": null,
      "team_id": null,
      "inviter_user_id": null,
      "invitee_user_id": null,
      "invite_type": null,
      "invite_country_code": null,
      "invite_target": null,
      "delivery_type": null,
      "role": null,
      "status": null,
      "accepted_by_user_id": null,
      "expired_at": null,
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": null
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": null,
      "sms": null,
      "site_inner_message": null
    }
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

POST Team-Einladung annehmen

POST /ep/team/invitations/accept

Der aktuell angemeldete Benutzer nimmt die Einladung mit einem einmaligen invitation_token an, das mit dem Einladungsziel übereinstimmen und zu der Website gehören muss, zu der die Einladung gehört; die team_id muss nicht übergeben werden.

Anfrageparameter

{
  "invitation_token": "string"
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

POST – Teameinladung ablehnen

POST /ep/team/invitations/reject

Der aktuell angemeldete Benutzer verwendet ein einmaliges invitation_token, um Einladungen abzulehnen, die seiner Identität entsprechen; die team_id ist nicht erforderlich.

Anfrageparameter

{
  "invitation_token": "string"
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

POST Teameinladung stornieren

POST /ep/team/invitations/cancel

Um ausstehende Einladungen innerhalb eines bestimmten Teams zu stornieren, muss der Operator die Berechtigung haben, die betreffende Rolle einzuladen.

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Aufzählungswert

Punkteverwaltung

Informationen zum Punktepaket erhalten

GET /web_v1/credit/info

Fragen Sie die Übersicht der Punktepakete für den aktuellen Ressourcenbereich ab. Für den Teambereich ist die Berechtigung USE_ASSETS erforderlich; diese Schnittstelle unterstützt den Anmeldestatus, den persönlichen API-Schlüssel und den Team-API-Schlüssel.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

POST-Anfrage zum Einstellen der automatischen Punkteauffüllung für das Guthaben

POST /web_v1/credit/update-auto-supplement

Diese Einstellung ermöglicht die automatische Auffüllung des aktuellen Ressourcenspeichers während der Anmeldung. Der Teamspeicher erfordert die Berechtigung USE_OWNER_PAYMENT_CAPABILITIES und ist derzeit nur für den Team-Superadministrator zugänglich; der Teamspeicher ist standardmäßig deaktiviert.

Anfrageparameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0
}

Anfrageparameter

Aufzählungswert

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

GET: Punkteverbrauchsdatensatz abrufen

GET /web_v1/credit/consumption-logs

Der Anmeldestatus oder der API-Schlüssel ermöglicht die paginierte Abfrage der aktuellen Verbrauchsdatensätze für Ressourcenbereiche. Für Teambereiche ist die Berechtigung VIEW_BILLING erforderlich.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

GET Punkte abrufen Datensatz zurücksetzen

GET /web_v1/credit/reset-logs

Anmeldestatus oder API-Schlüssel: Seitenweise Abfrage der Punkterücksetzungsdatensätze für den aktuellen Ressourcenbereich. Teambereiche erfordern die Berechtigung VIEW_BILLING.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Punktestatistiken erhalten Sie über GET

GET /web_v1/credit/stats

Anmeldestatus oder API-Schlüssel zum Abfragen der nach Verbrauchstyp aggregierten Punktestatistiken des aktuellen Ressourcenbereichs. Teambereiche benötigen die Berechtigung VIEW_BILLING.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Tägliche Punktestatistik abrufen

GET /web_v1/credit/daily-stats

Der Anmeldestatus oder der API-Schlüssel dient zur Abfrage des täglichen Guthabenverbrauchs des aktuellen Ressourcenbereichs (standardmäßig die letzten 7 Tage). Reguläre Teammitglieder sehen nur ihren eigenen Verbrauch; Administratoren, Superadministratoren und Finanzmitarbeiter mit der Berechtigung VIEW_BILLING sehen die vollständigen Teamdaten. Teamprotokolle von Mitgliedern ohne Verbrauchsdaten sind nur für die vollständige Ansicht sichtbar. API-Schlüsselabfragen dürfen maximal 31 Kalendertage (einschließlich) umfassen, wobei das Startdatum nicht nach dem Enddatum liegen darf.

Anfrageparameter

Aufzählungswert

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Stündliche Punktestatistik abrufen

GET /web_v1/credit/hourly-stats

Der Anmeldestatus oder der API-Schlüssel dient zur Abfrage des stündlichen Guthabenverbrauchs des aktuellen Ressourcenbereichs. Standardmäßig werden die letzten 7 Tage angezeigt. Für Teambereiche ist die Berechtigung VIEW_BILLING erforderlich. API-Schlüsselabfragen dürfen maximal 31 Kalendertage (einschließlich) umfassen, und das Startdatum darf nicht nach dem Enddatum liegen.

Anfrageparameter

Aufzählungswert

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Informationen zum Punktepaket erhalten

GET /ep/credit/info

Fragen Sie die Übersicht der Punktepakete für den aktuellen Ressourcenbereich ab. Für den Teambereich ist die Berechtigung USE_ASSETS erforderlich; diese Schnittstelle unterstützt den Anmeldestatus, den persönlichen API-Schlüssel und den Team-API-Schlüssel.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

GET: Punkteverbrauchsdatensatz abrufen

GET /ep/credit/consumption-logs

Der Anmeldestatus oder der API-Schlüssel ermöglicht die paginierte Abfrage der aktuellen Verbrauchsdatensätze für Ressourcenbereiche. Für Teambereiche ist die Berechtigung VIEW_BILLING erforderlich.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

GET Punkte abrufen Datensatz zurücksetzen

GET /ep/credit/reset-logs

Anmeldestatus oder API-Schlüssel: Seitenweise Abfrage der Punkterücksetzungsdatensätze für den aktuellen Ressourcenbereich. Teambereiche erfordern die Berechtigung VIEW_BILLING.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Punktestatistiken erhalten Sie über GET

GET /ep/credit/stats

Anmeldestatus oder API-Schlüssel zum Abfragen der nach Verbrauchstyp aggregierten Punktestatistiken des aktuellen Ressourcenbereichs. Teambereiche benötigen die Berechtigung VIEW_BILLING.

Anfrageparameter

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Tägliche Punktestatistik abrufen

GET /ep/credit/daily-stats

Der Anmeldestatus oder der API-Schlüssel dient zur Abfrage des täglichen Guthabenverbrauchs des aktuellen Ressourcenbereichs (standardmäßig die letzten 7 Tage). Reguläre Teammitglieder sehen nur ihren eigenen Verbrauch; Administratoren, Superadministratoren und Finanzmitarbeiter mit der Berechtigung VIEW_BILLING sehen die vollständigen Teamdaten. Teamprotokolle von Mitgliedern ohne Verbrauchsdaten sind nur für die vollständige Ansicht sichtbar. API-Schlüsselabfragen dürfen maximal 31 Kalendertage (einschließlich) umfassen, wobei das Startdatum nicht nach dem Enddatum liegen darf.

Anfrageparameter

Aufzählungswert

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Stündliche Punktestatistik abrufen

GET /ep/credit/hourly-stats

Der Anmeldestatus oder der API-Schlüssel dient zur Abfrage des stündlichen Guthabenverbrauchs des aktuellen Ressourcenbereichs. Standardmäßig werden die letzten 7 Tage angezeigt. Für Teambereiche ist die Berechtigung VIEW_BILLING erforderlich. API-Schlüsselabfragen dürfen maximal 31 Kalendertage (einschließlich) umfassen, und das Startdatum darf nicht nach dem Enddatum liegen.

Anfrageparameter

Aufzählungswert

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben

Rückgabedatenstruktur

Xcrawl-Aktivitätsprotokoll

GET-Abfrage: Liste der zuletzt durchgeführten Xcrawl-Aufgaben

GET /web_v1/xcrawl-activity-log/recent-runs

Melden Sie sich an, um die Liste und Zusammenfassung der einzelnen Aufgaben im aktuellen Ressourcenbereich abzurufen. Für den Teambereich ist die Berechtigung USE_ASSETS erforderlich; normale Mitglieder können nur Aufgaben einsehen, die mit ihren eigenen Anmeldeinformationen erstellt wurden, während Administratoren und Superadministratoren alle Teamaufgaben einsehen können.

Anfrageparameter

Aufzählungswert

Zurück zum Beispiel

200 Antworten

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ergebnisse zurückgeben