Logo Site EngageLab Mark Colored TransparentDokumentation
Suchen

Guthaben Abfragen

Wird verwendet, um das verfügbare Guthaben der App abzufragen, zu der der aktuelle API Key gehört. Die abgefragte App wird durch den API Key bestimmt, und es ist nicht erforderlich, die App-ID in der Anfrage zu übergeben.

Anfrage-URL

GET https://otp.api.engagelab.cc/v1/balance

Authentifizierung

Bitte lesen Sie Authentifizierung, um zu erfahren, wie Sie die API-Authentifizierung durchführen.

Anfragebeispiel

Anfrage-Header

GET /v1/balance HTTP/1.1 Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
              
              GET /v1/balance HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            
Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Keine Anfrageparameter.

Antwortparameter

Erfolgreiche Antwort

Feld Typ Option Beschreibung
currency String Erforderlich Abrechnungswährung, derzeit fest auf USD (US-Dollar)
balance String Erforderlich Normales Guthaben (durch Aufladung erhalten)
gift_balance String Erforderlich Geschenk-Guthaben (durch Aktivitäten / Geschenke erhalten, kann ein Ablaufdatum haben, wird nach Ablauf nicht gezählt)
total_balance String Erforderlich Gesamtguthaben, gleich balance + gift_balance
{ "currency": "USD", "balance": "123.4500", "gift_balance": "1.0000", "total_balance": "124.4500" }
              
              {
    "currency": "USD",
    "balance": "123.4500",
    "gift_balance": "1.0000",
    "total_balance": "124.4500"
}

            
Diesen Codeblock im schwebenden Fenster anzeigen

Feldbeschreibung

  1. Beträge sind alle String-Dezimalzahlen und behalten 4 Dezimalstellen. Dieses Design dient dazu, Genauigkeitsfehler bei der Übertragung und dem Parsen von Gleitkommazahlen zu vermeiden. Bitte verwenden Sie hochpräzise Dezimaltypen (wie BigDecimal / Decimal in verschiedenen Sprachen) für das Parsen und berechnen Sie nicht direkt als Gleitkommazahlen.
  2. Währung: Derzeit werden alle Apps in US-Dollar (USD) abgerechnet.
  3. Das Guthaben kann negativ sein: Bei Apps, die eine Überziehungsquote aktiviert haben, kann die balance / total_balance nach einer Überziehung einen negativen Wert zurückgeben (z. B. "-12.3400"), was darauf hinweist, dass Zahlungsrückstände bestehen. Bitte laden Sie rechtzeitig auf.
  4. total_balance wird vom Server im selben Moment konsistent berechnet und kann direkt zur Anzeige und zum Abgleich verwendet werden.

Fehlerhafte Antwort

Der HTTP-Statuscode lautet 4xx oder 5xx, und der Antworttext enthält die folgenden Felder:

Feld Typ Option Beschreibung
code int Erforderlich Fehlercode, siehe Beschreibung des Fehlercodes für Details
message String Erforderlich Fehlerdetails
{ "code": 2001, "message": "invalid token" }
              
              {
    "code": 2001,
    "message": "invalid token"
}

            
Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Fehlercode http code Beschreibung
1000 500 Interner Fehler, bitte versuchen Sie es später erneut
2001 401 Authentifizierung fehlgeschlagen, falsches Token übermittelt
2002 401 Authentifizierung fehlgeschlagen, Token ist abgelaufen oder wurde deaktiviert
2002 403 App nicht verfügbar (gelöscht oder deaktiviert)
Icon Solid Transparent White Qiyu
Vertrieb kontaktieren