Einführung in die BlockSec AML API
Der BlockSec AML API-Dienst bietet zwei Hauptsätze von APIs, die jeweils Dienste für Abfragen von Adressbeschriftungen und Abfragen von Adress-Compliance-Risiken bereitstellen.
Benutzer, die den API-Dienst vor dem 6. Mai abonniert haben, sollten v2 (eingestellt) besuchen, um auf die Dokumentation der vorherigen Version der API zuzugreifen. Wir werden die alte API-Version bis zum 1. Juli 2024 weiterhin unterstützen, daher bitte migrieren Sie Ihre relevanten Projekte vor diesem Stichtag auf die neue Version.
Der API-Schlüssel bleibt gültig und kann in beiden Versionen verwendet werden.
GET
POST
POST
GET
GET
POST
Die Ratenbegrenzung für jede API-Anfrage beträgt fünf Anfragen pro Sekunde, und jeder Abonnementplan begrenzt die Anzahl der täglich abgefragten Adressen. Weitere Informationen finden Sie auf unserer Abonnementseite.
(in )
Wenn Ihre HTTPS-Anfrage erfolgreich ist, werden in jeder Antwort die folgenden vier Hauptfelder angezeigt.
request_id
String
Die eindeutige ID für die aktuelle Anfrage. Wenn Sie Fragen oder Bedenken bezüglich der Ergebnisse dieser Anfrage haben, senden Sie uns bitte die Anfrage-ID zur Überprüfung.
code
Integer
Der Statuscode der Anfrage. Ein Code von 200000 zeigt eine erfolgreiche Anfrage an, während andere Codes auf Fehler hinweisen. Die Tabelle unten bietet eine umfassende Liste von Codes und deren Bedeutungen.
message
String
Informationen zum Code.
data
-
Detaillierte Ergebnisse. Dieses Feld variiert je nach Anfrage. Bitte beziehen Sie sich auf die Dokumentation jedes Endpunkts, um die Details zu erhalten.
200000
Erfolg
400001
Nicht autorisierte Operation
400002
Anforderungsrate ist zu hoch. Bitte versuchen Sie es später erneut.
400004
Ungültige Parameter
400005
Benutzer existiert nicht
400006
Server beschäftigt
400007
Ungültiger API-Schlüssel
400008
Ungültiges Authentifizierungsformat
400009
Der API-Schlüssel ist abgelaufen
400010
404 nicht gefunden!
400011
Ungültige Adresse. Bitte stellen Sie sicher, dass Sie die richtige Kette und Adresse angegeben haben.
400012
Tägliches Anforderungslimit überschritten. Bitte versuchen Sie es morgen erneut.
400013
Ungültige Parameter. Nicht unterstützter Kettenname
500000
Interner Fehler
Unsere API wird mit dem API-Schlüssel authentifiziert. Um die Sicherheit Ihrer Daten zu gewährleisten, teilen Sie bitte Ihren API-Schlüssel mit niemandem.
Um einen API-Schlüssel zu generieren, beginnen Sie mit der Registrierung für ein BlockSec-Konto. Nach der Registrierung können Sie im Einstellungen Bereich im APIs Panel schnell Ihren API-Schlüssel erhalten.
Wenn Sie den maßgeschneiderten API-Service über unseren Vertriebskanal abonniert haben, wenden Sie sich bitte an Ihren zugewiesenen Servicekontakt, um den API-Schlüssel zu erhalten.
Fügen Sie den "API-KEY" Header in die HTTP-Anfrageheader für jede API-Anfrage ein und geben Sie Ihren API-Schlüssel als Wert an. Siehe folgendes Beispiel.