produkt · api

Indexing-API

Zugang auf AnfrageStil REST · JSONAuth ein Schlüssel, ein Header

01 Zugang auf Anfrage

lies das zuerst

Schlüssel werden auf Anfrage ausgegeben, nicht über einen Knopf in deinem Dashboard. Schreib uns, sag uns, was du automatisieren würdest, und wir schalten es für dein Konto frei.

Fast alles, was der Dienst tut, läuft über das Dashboard: Du fügst eine Liste ein, du startest den Auftrag, du siehst ihm beim Abschließen zu. Das deckt den größten Teil ab. Deshalb bleibt die maschinenlesbare Tür schmal, und wir öffnen sie den Konten, die sie wirklich brauchen.

Was folgt, ist die gesamte Oberfläche, so wie sie entworfen ist. Sie ist kurz, und wenn dir etwas fehlt, schreib uns. Ein Endpunkt, den Leute wirklich aufrufen, ist mehr wert als zehn, die niemand aufruft.

02 Wie sie gebaut ist

REST über HTTPS, JSON rein und JSON raus, ein Schlüssel in einem Header, kein SDK zu installieren. Alles, was eine HTTP-Anfrage absetzen kann, kann sie steuern.

  • Ein Schlüssel pro Konto. An dich ausgegeben, auf Anfrage rotiert oder widerrufen.
  • Ein Header. Keine Signatur, kein OAuth-Tanz, kein Token zum Auffrischen.
  • Dieselben Objekte, die du ohnehin siehst. Ein über die API angelegter Auftrag ist der Auftrag in deinem Dashboard – dieselben Status, dieselben Details pro URL, dieselbe Historie.
  • Keine eigene Preisgestaltung. Derselbe Satz, aus demselben Guthaben, auf welchem Weg der Auftrag auch angelegt wurde.

Ein zweites Produkt ist das nicht. Es sind die Vorgänge des Dashboards selbst, mit einer maschinenlesbaren Tür davor.

03 Dein Schlüssel

Du schickst den Schlüssel bei jedem Aufruf mit. Das ist die ganze Authentifizierung:

bei jeder anfrage

X-API-Key: <dein Schlüssel>

Der Schlüssel identifiziert das Konto und gibt das Guthaben dieses Kontos aus. Er lässt sich jederzeit rotieren oder widerrufen, ohne dein Passwort oder deine offenen Sitzungen anzurühren. Behandle ihn wie ein Zugangsgeheimnis: Er gehört auf deinen Server, nicht in einen Browser, ein öffentliches Repository oder ein Support-Ticket.

Eine Anfrage ohne gültigen Schlüssel wird abgelehnt, bekommt keine Begründung und ist nicht von einer Anfrage an einen Pfad zu unterscheiden, den es nicht gibt. Dasselbe Prinzip wenden wir überall sonst an.

04 Was du aufrufen kannst

Sechs Operationen, die eins zu eins auf das abbilden, was das Dashboard tut:

  • Einen Auftrag anlegen – eine Liste von URLs senden und einen Auftrag als Entwurf zurückbekommen. Es wird nichts abgebucht und noch nichts eingereiht.
  • Ihn starten – der separate Aufruf, der die Kampagne startet und das Guthaben belastet. Getrennt aus gutem Grund: Ein Entwurf ist der eine sichere Ort, um die Liste zu prüfen.
  • Deine Aufträge auflisten – neueste zuerst, seitenweise, mit dem Zustand jedes einzelnen.
  • Einen Auftrag lesen – seinen Status, seine Zähler und die Details pro URL, während die Kampagne läuft.
  • Dein Guthaben abfragen – was übrig ist, dieselbe Zahl, die das Dashboard zeigt.
  • Einen Entwurf löschen – solange er noch ein Entwurf ist. Sobald er gelaufen ist, gibt es nichts zu stornieren; siehe die Erstattungsrichtlinie.

Keine Webhooks in der ersten Fassung, kein Massenexport, keine Reporting-Endpunkte – du fragst einen Auftrag ab und bekommst seinen Zustand. Wenn Polling für das, was du baust, nicht reicht, sag uns auch das.

05 Grenzen und Regeln

Nichts davon ist der API eigen. Es ist derselbe Dienst mit einer anderen Tür:

  • Dieselbe Mindest- und Höchstzahl an URLs pro Auftrag wie im Dashboard, und so viele Aufträge, wie du willst – siehe Preise.
  • Derselbe Preis pro URL, in dem Moment vom Guthaben genommen, in dem der Auftrag startet.
  • Ratenbegrenzung pro Schlüssel, hoch genug für echte Automatisierung und niedrig genug, um eine Schleife mit einem Fehler darin zu überstehen.
  • Die Richtlinie zur akzeptablen Nutzung gilt genau so wie im Dashboard. Ein Schlüssel erweitert nicht, was du einreichen darfst.

Fehler kommen als JSON zurück, mit einem Statuscode, der meint, was er sagt. Eine abgelehnte URL wird pro URL gemeldet und nicht als fehlgeschlagene Anfrage – ein fehlerhafter Eintrag wirft nicht den Rest der Liste weg.

06 Was sie nicht ist

API-Seiten deuten üblicherweise mehr an, als sie liefern, also der Klarheit halber:

  • Kein Weg, die Methode zu kaufen. Sie legt Aufträge an. Was danach mit einer URL passiert, ist dieselbe geschlossene Pipeline, die in den Nutzungsbedingungen beschrieben ist, und kein Endpunkt wird sie je offenlegen.
  • Keine Garantie für Indexierung. Ein angenommener Auftrag heißt, dass die Arbeit eingereiht ist – genau das, was der Knopfdruck im Dashboard heißt, nicht mehr.
  • Keine Reseller-Schnittstelle. Wiederverkauf oder White-Labeling braucht zuerst eine schriftliche Vereinbarung: sales@index-pages.com.
  • Nicht die Endpunkte, die unsere eigene Flotte nutzt. Die gibt es, sie sind intern, sie sind nicht für Kunden gedacht, und sie sind nicht das, was diese Seite beschreibt.

07 Schlüssel anfragen

Schreib von der Adresse deines Kontos an support@index-pages.com, mit zwei Zeilen dazu, was du automatisieren würdest. Dieser zweite Teil schiebt die Sache nach oben, weil wir gegen echte Nutzung bauen und nicht gegen ein Formular für Feature-Wünsche.

Den Fahrplan bestimmt hier die Nachfrage. Es gibt keine Warteliste, kein Beta-Programm und keine Hürde: Wenn du sie brauchst, sag es. Alles andere steht auf der Kontaktseite.