Das Technische...

Die Sphere 360° API-Schnittstelle

Unser Ziel ist eine API-Schnittstelle für die einfache und sichere Abfrage und Verifizierung der Daten zu erstellen:
Wir setzen daher bei der Übermittlung der Daten ausschließlich auf verschlüsselte (SSL) POST Abfragen.

Das API-Package beinhaltet ein php-Baustein mit Beispiel der Anwendung.

API-Download


Die Abfrage:
$obj = DataCheck($request_data, $myapikey, false);
$request_data = E-Mail Adresse, Domain Name, Telefonnummer
$myapikey = Ihr persönlicher Zugangsschlüssel (API-Key)
false|true = Fehlerreporting aktivieren (true) bzw. deaktivieren (false)


Die Auswertung / Rückmeldung in einem JSON-Format:
$DeineVariable = $obj['Datenfeld'];


Verfügbare Datenfelder:

Hinweis: Diese Datenfelder stehen leider nicht in unserem kostenlosen Paket zur Verfügung. Es erfolgt eine 'null' Rückmeldung.


Grundfunktionen

Datenfeld Beschreibung Rückmeldung
$obj['request_provided']
Rückgabe der ursprünglich gesendeten Anfrage. [string]
info-Entfernen Sie diesen Text-
												@example.com
example.com
+491234567890
$obj['request_type']
Art der gesendeten Anfrage. [string]
domain
e-mail
phone
unknown
$obj['spam_result']
Ob Anfrage als SPAM erkannt wurde bzw. ein SPAM-Verdacht vorliegt.
Bei aufgebrauchtem Kontingent oder einem Fehler erfolgt eine 'false'-Meldung.
[boolean]
true
false
$obj['spam_result_str']
Rückgabe des SPAM-Ergebnis. [string]
ok
listed
error
$obj['spam_result_type']
Gelistete SPAM Kategorie (wenn verfügbar). [string]
email
temporary email
spam
call
sms
none
$obj['error']
Fehler bei der API-Verwendung vorhanden. [boolean]
false
true
$obj['error_details']
Detailinformationen zu den aufgetretenen Fehler. [string]
siehe Fehlercodes
null
$obj['api_version']
Versionsinfo der Online-API [string]
"Version"
"Buildnummer"
Account-Funktionen

Datenfeld Beschreibung Rückmeldung
$obj['account_package']
Angabe des aktuellen Paketes im aktuellen Abrechnungszeitraum. [string]
FREE 100
PRO-BASIC
PRO-PROFESSIONAL
PRO-INDIVIDUAL
$obj['account_query_status']
Prozentuale Angabe der bereits genutzen Abfragekapazität [double]
0.0 ... 100.0
E-Mail & Domain Funktionen

Datenfeld Beschreibung Rückmeldung
$obj['domain_name']
Name der Domain [string]
example.com
...
$obj['domain_tld_name']
Name der Domain-Endung (TLD - Top Level Domain) [string]
.com
...
$obj['domain_sub']
Rückmeldung ob es sich um eine Sub-Domain handelt [boolean]
true
false
$obj['domain_sub_name']
Name der Sub-Domain: subdomain.hauptdomain.tld [string]
subdomain
$obj['domain_main_name']
Name der Hauptdomain mit tld: subdomain.hauptdomain.tld [string]
hauptdomain.tld
Telefon Funktionen

Eine vollständige Auswertung kann nur bei Eingabe einer Telefonnummer inklusive Ländervorwahl (Prefix) erfolgen.


Datenfeld Beschreibung Rückmeldung
$obj['phone_number']
Rückgabe der abgefragten Telefonnummer gemäß der internationalen Richtlinie E.164 (Nachfolger der Richtlinie E.163) [string]
+1234567890
$obj['phone_prefix']
Erkanntes Länderprefix (Ländervorwahl) [string]
+1
$obj['phone_city']
Geolocation bzw. Ort (engl.) der Rufnummer wenn bekannt. [string]
city
$obj['phone_country_en']
Ländername (Englisch) des erkannten Prefix [string]
country
$obj['phone_country_de']
Ländername (Deutsch) des erkannten Prefix [string]
Land
$obj['phone_country_iso2']
Länderkürzel nach ISO 3166 ALPHA-2 [string]
DE
US
...
$obj['phone_country_iso3']
Länderkürzel nach ISO 3166 ALPHA-3 [string]
DEU
USA
...
$obj['phone_continent']
Kontinentale Zuordnung der Rufnummer [string]
AFRICA
AMERICA
ASIA
EUROPE
AUSTRALIA & OCEANIA
$obj['phone_zone']
Angabe der Telefonzone [string]
1 ... 9
$obj['phone_number_format_international']
Formatierung der Telefonnummer in internationles Format [string]
+1 234 567890
$obj['phone_number_format_national']
Formatierung der Telefonnummer in nationales/lokales Format [string]
0234 567890
$obj['phone_number_format_RFC3966']
Formatierung der Telefonnummer in URI-Link (RFC3966) Format [string]
tel:+1-234-567890
$obj['phone_number_initial_provider']
(Mobilfunk-)Telefonanbieter dem der Prefix-Nummernkreis ursprünglich zugeordnet wurde.
Durch die Mitnahme-Möglichkeit der Telefonnummer zu einem anderen Anbieter (sogenannte Rufnummernportierung) kann keine aktuelle Zuordnung getroffen werden!
[string]
Provider-Name
$obj['phone_number_timezone']
Zeitzone der Rufnummer [string]
Zeitzonen-Bezeichnung
$obj['phone_number_type']
Typ der Rufnummer (Festnetz, Mobil, Gebührenfreie-Service-Nr.) [string]
landline
mobile
landline / mobile
toll-free
unknown
Fehlercodes

Code Beschreibung
E000
Verbindungsproblem zur Online-API (siehe ausgegebene Fehler-Beschreibung) (Offline-Error)
E01
Account-Error
E01.1
API-Key ungültig
E01.2
Account ungültig / nicht vorhanden
E01.3
Zahlungsperiode abgelaufen
E01.4
Max. Abfragekontingent erreicht
E01.5
Die Anfrage wurde auf Grund eines Account Problems blockiert
E02
Die Art der Anfrage konnte nicht ermittelt werden (unbekannter bzw. ungültiger Abfragetyp)
E03
Die Anfrage konnte intern nicht verarbeitet werden.

Alle Angaben ohne Gewähr, Änderungen vorbehalten.