====== SEOLizer- API ======

Mit unserer API hast Du direkten Zugriff auf unsere Domaindaten. Dazu zählen Funktionen wie

  * Finde thematisch ähnliche Domains (Similar Domains)
  * Finde Domains die auf eine bestimmte Domain weiterleiten (301 Redirects)
  * Gebe die aktuelle Trustedshops- Bewertung zurück (Verlauf eines Zeitraums ist auch möglich)
  * Finde Domains auf einer angegebenen IP- Adresse (Domain- Reverse- Lookup)

Du kannst Domaindaten abrufen, Projekte verwalten und Projektdaten abrufen.

**Aktuelle Version:** V2.0

===== API- Funktionsübersicht =====

==== Accountfunktionen ====

 [[seolizer-_api:account-funktionen|Accountfunktionen]] 

==== Domainfunktionen ====

Mit den [[seolizer-_api:domain-funktionen|Domainfunktionen]] hast Du Zugriff auf die Domaindaten.
 



==== Projektfunktionen ====

[[seolizer-_api:projekt-funktionen|Projektfunktionen]]

==== Sonstige Funktionen ====

|< 50em 20% >|
^Funktion^Beschreibung^
|putimage|interne Verwendung|
|getgeoname|interne Verwendung|
|getgeonames|interne Verwendung|
|adddomaintoredis|interne Verwendung|



===== Autorisierung an der API =====
Unsere API nutzt ein einfachen Autorisierungscode der als Parameter (key) jeder API- Anfrage angehängt werden muss.
**Beipielaufruf:**

''https://seolizer.de/api/current/isdomainexists/?key=[DeinKey]&domain=test.de''

Ungültige Anfragen an unserer API werden nach einer bestimmten Anzahl von Versuchen für eine gewisse Zeit blockiert. Dies dient dem Schutz vor Missbrauch unserer API und Deinen Credits.

===== Testen der Verbindung =====

==== Fehlermeldung bei ungültigem API-Key ====
<file xml>
<domain>
    <request credits="0">  // Ihrem Konto wurden keine Credits belastet, da die Funktion mit einem Fehler zurückgegeben wurde
        <action>isdomainexists</action>  // Funktionsaufruf
        <domain>test.de</domain>  // Domain
    </request>
    <response version="1.1">
        <errorno>300</errorno>  // Fehlercode
        <error>Invalid ApiKey</error>  // Fehlermeldung im Klartext
    </response>
</domain>
</file>
===== Ein API- Key bekommen =====

Für die meisten API- Anfragen benötigest Du ein gültigen API- Key. Diesen kannst Du als Administrator direkt in den [[dein_seolizer-account:api-key|Account- Einstellungen]] erstellen.
===== Credits pro Anfrage =====

Pro API- Call berechnen wir je nach Art der Anfrage eine gewisse Anzahl an Credits. Die Credits werden in Ihrem Account automatisch jeden Sonntag um 23:59 Uhr wieder aufgefüllt. So stehen Ihnen je nach gebuchtem Paket eine gewisse Anzahl an Credits zur freien Verfügung. Wie viel Credits ein API- Call verbraucht entnhemen Sie bitte der Dokumentation der jeweiligen Funktion.

===== Anfragen an der API =====

Jede Anfrage kann und muss als HTTP- Get- Request gesendet werden.

===== Spezielle API- Version verwenden =====

Standardmäßig verwenden wir immer die aktuellste API- Version.

**Beipielaufruf:**

''https://seolizer.de/api/current/isdomainexists/?apikey=[DeinKey]&domain=test.de''

Dabei ist die Angabe "current" dabei der Schlüssel um immer auf die aktuellste Version zuzugreifen. Wenn Du eine spezielle Version verwenden möchtest kannst Du die natürlich unter Angabe der gewünschten Versinsnummer.

**Beipielaufruf für einen Call an die API der Version 1.0:**

''https://seolizer.de/api/1.0/?action=isdomainexists&apikey=[DeinKey]&domain=test.de''

===== Eine Beispiel-Antwort der API =====

<file xml>
<domain>
  <request credits="10">  // Der Aufruf kostete 10 Credits
    <action>readdomain</action>  // Die Funktion readdomain wurde aufgerufen
  </request>
  <response version="1.1">  // Antwort der API mit der Version 1.1
    <errorno>0</errorno>  // Fehlercode 0 wurde zurückgegeben (Fehlerfrei durchgeführt)
    <domain>test.de</domain>  // Antwort bezieht sich auf die Domain test.de
    <id>859676</id>  // interne Verwaltungsschlüssel der Domain
    <ip hostcount="35">52.174.71.95</ip>  // IP- des Servers auf dem die Domain gehostet wird, 35 weitere Domains auf der IP bekannt
    <ipnet>52.168.0.0/13</ipnet>  // Subnet in dem sich der Server befindet
    <provider>Microsoft Corporation</provider>  // Zuständiger Provider
    <cms>Noxum Website Publisher</cms>  // entdecktes CMS der Website
    <imprintUrl/>  // URL zum Impressum
    <gtmid/>  // Google- Tag- Manager- Conatiner- ID
    <dataProtectionUrl>  // URL zur Datenschutzerklärung
      <redirectdomains domaincount="25">  // 25 Domains leiten per Redirect auf die Domain test.de um
        <domain>alternative-heilmethoden-im-test.de</domain>
        <domain>fettest.de</domain>
        <domain>finanztest24.de</domain>
        <domain>finanz-test.de</domain>
      </redirectdomains>
      <similardomains domaincount="28"> // 28 ähnliche Webseiten bekannt
        <domain>verbraucherzentrale.de</domain>
        <domain>guter-rat.de</domain>
        <domain>warentest.de</domain>
      </similardomains>
    </response>
</domain>
</file>

===== Wichtige Fragen =====

===== API V2.0 (Rest) =====

Mit der [[seolizer-_api:api-v2|API ab Version 2]]

Funktionen sind hier nach folgenden Kategorien unterteilt:

  *  [[seolizer-_api:system-funktionen|Systemfunktionen]]  
  * [[seolizer-_api:mandanten-funktionen|Mandantenfunktionen]] (Ehemals Account-Funktionen)
  * [[seolizer-_api:domain-funktionen|Domainfunktionen]]
  * [[seolizer-_api:projekt-funktionen|Projektfunktionen]]
  * [[seolizer-_api:list-funktionen|Listen-Funktionen]]
  * [[seolizer-_api:ips-funktionen|IP-Funktionen]]
  * [[seolizer-_api:phrasen-funktionen|Phrasen-Funktionen]]
  * [[seolizer-_api:indexing-funktionen|Indexing-Funktionen]]