API-Dokumentation

API-Adresse: https://2index.ninja/api/v1/

Um eine Anfrage an die API zu stellen, müssen Sie das Bearer-Zugriffstoken im Autorisierungsheader übergeben.

 Das Zugriffstoken erhalten Sie bei der entsprechenden curl https://2index.ninja/api/v1/account -H "Authorization: Bearer API_TOKEN"

Abschnitt im Benutzerkonto.

Die Antwort auf jede Anfrage enthält einen success , der den Erfolg der Anfrage bestimmt. Der errors enthält Fehlermeldungen.

In einigen Fällen müssen Sie bei der Rückgabe eines 403-Fehlers den Benutzeragenten angeben, zum Beispiel:

 Anfragen können durch den Hosting-Anbieter eingeschränkt sein. In diesem Fall empfehlen wir die Verwendung eines Proxys. curl https://2index.ninja/api/v1/account -H "Authorization: Bearer API_TOKEN" -A "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36"

Methoden zum Arbeiten mit einem Konto

Kontodetails abrufen

Sie müssen eine GET-Anfrage an die account senden

 Die Antwort enthält Daten im JSON-Format: GET https://2index.ninja/api/v1/account

 { "success": true, "account": { "email": "[email protected]", "tariff": "White Ninja", "balance": 100.0, "available_projects": 1, "available_links": 100, "available_indexation_check_links": 500, "link_sending_speed": 100, "tariff_available": true, "tariff_expiring_date": "2025-01-16T14:26:11.000000Z", "email_verified": false, "link_cost": "$0.00056" } } Methoden zur Arbeit mit Projekten { "success": true, "account": { "email": "[email protected]", "tariff": "White Ninja", "balance": 100.0, "available_projects": 1, "available_links": 100, "available_indexation_check_links": 500, "link_sending_speed": 100, "tariff_available": true, "tariff_expiring_date": "2025-01-16T14:26:11.000000Z", "email_verified": false, "link_cost": "$0.00056" } } 

Holen Sie sich eine Liste der Projekte

Sie müssen eine GET-Anfrage an die project senden

 Die Antwort enthält Daten im JSON-Format: GET https://2index.ninja/api/v1/project

 { "success": true, "projects": [ { "id": 1, "name": "Project name", "type": "indexing", "website": "https://domain.com/", "status": "in progress", "created_at": "2024-03-01 14:34:56", "links_type": "internal", "google_account_access_granted": 0, "links_total": 500, "links_sending_speed": 400, "links_sent_google": 100, "links_sent_yandex": 40, "links_sent_bing": 100, "in_queue": 360, "sent_links": 100, "indexed": 30, "not_indexed": 0, "download_queue_url": "DOWNLOAD_QUEUE_URL", "download_sent_url": "DOWNLOAD_SENT_URL", "download_indexed_url": "DOWNLOAD_INDEXED_URL", "download_unindexed_url": "DOWNLOAD_UNINDEXED_URL" }, { "id": "2", "name": "Project 2 name", "type": "indexing_check", "status": "in progress", "created_at": "2024-03-01 14:34:56", "links_total": 200, "links_checking_speed": 100, "in_queue": 100, "checked": 100, "indexed": 70, "not_indexed": 30, "download_queue_url": "DOWNLOAD_QUEUE_URL", "download_indexed_url": "DOWNLOAD_INDEXED_URL", "download_unindexed_url": "DOWNLOAD_UNINDEXED_URL", "download_all_url": "DOWNLOAD_ALL_URL", "download_checked_url": "DOWNLOAD_CHECKED_URL", } ... ] } Projektdaten abrufen { "success": true, "projects": [ { "id": 1, "name": "Project name", "type": "indexing", "website": "https://domain.com/", "status": "in progress", "created_at": "2024-03-01 14:34:56", "links_type": "internal", "google_account_access_granted": 0, "links_total": 500, "links_sending_speed": 400, "links_sent_google": 100, "links_sent_yandex": 40, "links_sent_bing": 100, "in_queue": 360, "sent_links": 100, "indexed": 30, "not_indexed": 0, "download_queue_url": "DOWNLOAD_QUEUE_URL", "download_sent_url": "DOWNLOAD_SENT_URL", "download_indexed_url": "DOWNLOAD_INDEXED_URL", "download_unindexed_url": "DOWNLOAD_UNINDEXED_URL" }, { "id": "2", "name": "Project 2 name", "type": "indexing_check", "status": "in progress", "created_at": "2024-03-01 14:34:56", "links_total": 200, "links_checking_speed": 100, "in_queue": 100, "checked": 100, "indexed": 70, "not_indexed": 30, "download_queue_url": "DOWNLOAD_QUEUE_URL", "download_indexed_url": "DOWNLOAD_INDEXED_URL", "download_unindexed_url": "DOWNLOAD_UNINDEXED_URL", "download_all_url": "DOWNLOAD_ALL_URL", "download_checked_url": "DOWNLOAD_CHECKED_URL", } ... ] }

Sie müssen eine GET-Anfrage an die Adresse project/{project_id} stellen.

 Die Antwort enthält Daten im JSON-Format: GET https://2index.ninja/api/v1/project/1

• Für das Indexierungsprojekt:

 { "success": true, "project": { "id": 1, "name": "Project name", "type": "indexing", "website": "https://domain.com/", "status": "in progress", "created_at": "2024-03-01 14:34:56", "links_type": "internal", "google_account_access_granted": 0, "links_total": 500, "links_sending_speed": 400, "links_sent_google": 100, "links_sent_yandex": 40, "links_sent_bing": 100, "in_queue": 360, "sent_links": 100, "indexed": 30, "not_indexed": 0, "download_queue_url": "DOWNLOAD_QUEUE_URL", "download_sent_url": "DOWNLOAD_SENT_URL", "download_indexed_url": "DOWNLOAD_INDEXED_URL", "download_unindexed_url": "DOWNLOAD_UNINDEXED_URL" } } Für das Indexierungsüberprüfungsprojekt: { "success": true, "project": { "id": 1, "name": "Project name", "type": "indexing", "website": "https://domain.com/", "status": "in progress", "created_at": "2024-03-01 14:34:56", "links_type": "internal", "google_account_access_granted": 0, "links_total": 500, "links_sending_speed": 400, "links_sent_google": 100, "links_sent_yandex": 40, "links_sent_bing": 100, "in_queue": 360, "sent_links": 100, "indexed": 30, "not_indexed": 0, "download_queue_url": "DOWNLOAD_QUEUE_URL", "download_sent_url": "DOWNLOAD_SENT_URL", "download_indexed_url": "DOWNLOAD_INDEXED_URL", "download_unindexed_url": "DOWNLOAD_UNINDEXED_URL" } }

 { "success": true, "project": { "id": "2", "name": "Project 2 name", "type": "indexing_check", "status": "in progress", "created_at": "2024-03-01 14:34:56", "links_total": 200, "links_checking_speed": 100, "in_queue": 100, "checked": 100, "indexed": 70, "not_indexed": 30, "download_queue_url": "DOWNLOAD_QUEUE_URL", "download_indexed_url": "DOWNLOAD_INDEXED_URL", "download_unindexed_url": "DOWNLOAD_UNINDEXED_URL", "download_all_url": "DOWNLOAD_ALL_URL", "download_checked_url": "DOWNLOAD_CHECKED_URL" } } Erstellen eines Projekts { "success": true, "project": { "id": "2", "name": "Project 2 name", "type": "indexing_check", "status": "in progress", "created_at": "2024-03-01 14:34:56", "links_total": 200, "links_checking_speed": 100, "in_queue": 100, "checked": 100, "indexed": 70, "not_indexed": 30, "download_queue_url": "DOWNLOAD_QUEUE_URL", "download_indexed_url": "DOWNLOAD_INDEXED_URL", "download_unindexed_url": "DOWNLOAD_UNINDEXED_URL", "download_all_url": "DOWNLOAD_ALL_URL", "download_checked_url": "DOWNLOAD_CHECKED_URL" } }

Sie müssen eine POST-Anfrage an project senden

 Anforderungsparameter: POST https://2index.ninja/api/v1/project

** Beim Erstellen eines Projekts beliebigen Typs können Sie entweder indexing_speed oder checking_speed verwenden. Sie sind Aliase füreinander, aber wenn beide übergeben werden, wird indexing_speed verwendet.

Die Antwort enthält Daten im JSON-Format:

 { "success": true, "message": "The project has been successfully created" } Ein Beispiel für die Erstellung eines Linkindexierungsprojekts: { "success": true, "message": "The project has been successfully created" }

POST https://2index.ninja/api/v1/project

 name: Project 1 website: https://website.com for_external_links: 1 indexing_speed: 100 Ein Beispiel für die Erstellung eines Linkindexierungs-Checkprojekts: name: Project 1 website: https://website.com for_external_links: 1 indexing_speed: 100

POST https://2index.ninja/api/v1/project

 name: Project 2 checking_speed: 100 Indizierungswarteschlange löschen name: Project 2 checking_speed: 100

Sie müssen eine POST-Anfrage an project/{project_id}/clear_queue senden

 Die Antwort enthält Daten im JSON-Format: POST https://2index.ninja/api/v1/project/1/clear_queue

 { "success": true, "message": "The indexing queue has been cleared successfully. X links have been removed" } Oder es wird die entsprechende Fehlermeldung zurückgegeben: { "success": true, "message": "The indexing queue has been cleared successfully. X links have been removed" }

 { "success": false, "errors": ["Project not found"] } Methoden zum Arbeiten mit Links { "success": false, "errors": ["Project not found"] } 

Links hinzufügen

Sie müssen eine POST-Anfrage an die link/add -Adresse senden

 Anforderungsparameter: POST https://2index.ninja/api/v1/link/add

Die Antwort enthält Daten im JSON-Format:

 { "success": true, "message": "Links have been successfully added to the project" } Sollten in der Liste ungültige Links vorhanden sein, werden diese nicht hinzugefügt und es erfolgt eine entsprechende Fehlermeldung als Antwort: { "success": true, "message": "Links have been successfully added to the project" }

 { "success": false, "errors": ["You sent invalid links"], "invalid_links": ["http://wrong.link"] } Für Projekte { "success": false, "errors": ["You sent invalid links"], "invalid_links": ["http://wrong.link"] }

Die Überprüfung der Linkindexierung erfolgt auf die gleiche Weise wie bei der Indexierung. google_access_granted ist optional und wird ignoriert. Suchmaschinen müssen angegeben werden, derzeit sind jedoch nur Google-Suchen verfügbar.

Links nach Projektnamen hinzufügen

Sie müssen eine POST- Anfrage an link/add_simple senden. Wenn ein Projekt mit dem angegebenen Namen nicht vorhanden ist, wird es automatisch mit der maximalen Upload-Geschwindigkeit erstellt.

 Anforderungsparameter: POST https://2index.ninja/api/v1/link/add_simple

Bei Indexverifizierungsprojekten werden Links auf die gleiche Weise wie bei der Indexierung hinzugefügt. google_access_granted ist optional und wird ignoriert. Suchmaschinen müssen angegeben werden, die Verifizierung ist derzeit jedoch nur für Google verfügbar.

Beispielanfrage:

 { "project_name": "My Website", "links": ["https://example.com/page1", "https://example.com/page2"], "google": true, "yandex": false, "bing": true, "google_access_granted": false } Antwort bei Erfolg: { "project_name": "My Website", "links": ["https://example.com/page1", "https://example.com/page2"], "google": true, "yandex": false, "bing": true, "google_access_granted": false }

 { "success": true, "message": "Links have been successfully added to the project", "project_name": "My Website", "project_id": 12345 } Mögliche Fehler: { "success": true, "message": "Links have been successfully added to the project", "project_name": "My Website", "project_id": 12345 }

• Wenn die Liste fehlerhafte Links enthält:

 { "success": false, "errors": ["You sent invalid links"], "invalid_links": ["http://wrong.link"] } Wenn beim Erstellen eines Projekts ein Fehler aufgetreten ist: { "success": false, "errors": ["You sent invalid links"], "invalid_links": ["http://wrong.link"] }

 { "success": false, "errors": ["Failed to create the project"] } Linkstatus prüfen { "success": false, "errors": ["Failed to create the project"] } 

Führen Sie eine POST-Anfrage an die Adresse aus   /api/v1/link/status

 Anforderungsparameter: POST https://2index.ninja/api/v1/link/status 

• Wenn die Anfrage erfolgreich ist, wird als Antwort ein JSON-Objekt empfangen:

 { "success" : true , "link" : { "id" : 34368960 , "url" : "https://2index.ninja/" , "google" : "Sent" , "yandex" : "Sent" , "bing" : "Sent" , "is_external" : 1 , "google_sent" : "2025-08-24 20:10:02" , "yandex_sent" : "2025-08-24 20:45:02" , "bing_sent" : "2025-08-24 20:05:05" , "google_indexed" : 1 , "google_indexing_check_date" : "2025-08-29" } } Wo: { "success" : true , "link" : { "id" : 34368960 , "url" : "https://2index.ninja/" , "google" : "Sent" , "yandex" : "Sent" , "bing" : "Sent" , "is_external" : 1 , "google_sent" : "2025-08-24 20:10:02" , "yandex_sent" : "2025-08-24 20:45:02" , "bing_sent" : "2025-08-24 20:05:05" , "google_indexed" : 1 , "google_indexing_check_date" : "2025-08-29" } } 

* Mögliche Status:

• Im Fehlerfall wird ein JSON-Objekt mit der Fehlermeldung zurückgegeben. Beispiele für Fehler:

 { "success" : false , "errors" : { "link" : [ "The link field is required." ] } } { "success" : false , "errors" : [ "Project not found" ] } { "success" : false , "errors" : { "link" : [ "The link field is required." ] } } 

 { "success" : false , "errors" : [ "Project not found" ] } { "success" : false , "errors" : [ "URL not found" ] } { "success" : false , "errors" : [ "Project not found" ] } 

 { "success" : false , "errors" : [ "URL not found" ] } Sie können den Linkstatus auch anhand der Link-ID abrufen { "success" : false , "errors" : [ "URL not found" ] } 

Führen Sie dazu eine GET-Anfrage an die Adresse   /api/v1/link/status/ID

 Die Antwort auf die Anfrage ist dieselbe wie in der vorherigen Version. GET https://2index.ninja/api/v1/link/status/ID

Arbeiten mit Referenzquellen

Linkquellen stehen für alle Projekttypen zur Verfügung und werden identisch verarbeitet. Für Indexcheck-Projekte steht ausschließlich Google zur Verfügung.

Hinzufügen einer Sitemap

Senden Sie eine POST-Anfrage an /api/v1/sitemap/add

 Anforderungsparameter: POST https://2index.ninja/api/v1/sitemap/add

Mögliche Fehler:

Beispielantworten:

Sitemap erfolgreich hinzugefügt:

 { "success": true, "message": "Карта сайта успешно добавлена, мы скачаем её как можно скорее и отправим уведомление по электронной почте после завершения." } Validierungsfehler: { "success": true, "message": "Карта сайта успешно добавлена, мы скачаем её как можно скорее и отправим уведомление по электронной почте после завершения." }

 { "errors": ["sitemap":["The sitemap field is required."]] } Projekt nicht gefunden: { "errors": ["sitemap":["The sitemap field is required."]] }

 { "errors": ["Project not found"] } Sitemap-Tracking-Statusaktualisierung { "errors": ["Project not found"] } 

Senden Sie eine POST-Anfrage an /api/v1/sitemap/update_watch

 Anforderungsparameter: POST https://2index.ninja/api/v1/sitemap/update_watch

Mögliche Fehler:

Beispielantworten:

Erfolgreiche Aktualisierung des Tracking-Status:

 { "success": true } Linkquelle nicht gefunden: { "success": true }

 { "errors": ["Link source not found"] } Entfernen einer Linkquelle { "errors": ["Link source not found"] }

Senden Sie eine POST-Anfrage an /api/v1/sitemap/delete

 Anforderungsparameter: POST https://2index.ninja/api/v1/sitemap/delete

Mögliche Fehler:

Beispielantworten:

Erfolgreiche Entfernung der Linkquelle:

 { "success": true, "message": "Источник ссылок успешно удален" } Projekt nicht gefunden: { "success": true, "message": "Источник ссылок успешно удален" }

 { "errors": ["Project not found"] } Liste der Referenzquellen { "errors": ["Project not found"] }

Um eine Liste der hinzugefügten Linkquellen zu erhalten, müssen Sie eine POST-Anfrage an https://2index.ninja/api/v1/link_sources senden.

Übergeben Sie project_id in der Anfrage

Als Ergebnis wird folgender Datensatz zurückgegeben:

 [ { "id": 1247, "project_id": 3540, "name": "urls.txt", "type": "text file", "created_at": "2025-01-17T15:51:43.000000Z", "processing_date": "2025-01-17T15:51:48.000000Z", "has_error": false, "error_message": "", "status": "success", "is_pending": false, "is_success": true, "total_links": 29585, "added_links": 29582, "invalid_links": 3, "watch": 0, "google_access_granted": 0, "is_external_links": 1, "search_engines": { "google": "1" } }, { "id": 22, "project_id": 3540, "name": "https://2index.ninja/sitemap.xml", "type": "sitemap", "created_at": "2025-07-03T14:24:23.000000Z", "processing_date":, "has_error":, "error_message":, "status": "pending", "is_pending": 1, "is_success":, "total_links": 0, "added_links": 0, "invalid_links": 0, "watch": 1, "google_access_granted": 0, "is_external_links": 1, "search_engines": { "google": 1 } } ] Wo [ { "id": 1247, "project_id": 3540, "name": "urls.txt", "type": "text file", "created_at": "2025-01-17T15:51:43.000000Z", "processing_date": "2025-01-17T15:51:48.000000Z", "has_error": false, "error_message": "", "status": "success", "is_pending": false, "is_success": true, "total_links": 29585, "added_links": 29582, "invalid_links": 3, "watch": 0, "google_access_granted": 0, "is_external_links": 1, "search_engines": { "google": "1" } }, { "id": 22, "project_id": 3540, "name": "https://2index.ninja/sitemap.xml", "type": "sitemap", "created_at": "2025-07-03T14:24:23.000000Z", "processing_date":, "has_error":, "error_message":, "status": "pending", "is_pending": 1, "is_success":, "total_links": 0, "added_links": 0, "invalid_links": 0, "watch": 1, "google_access_granted": 0, "is_external_links": 1, "search_engines": { "google": 1 } } ]

id - ID der Linkquelle
project_id – Projekt-ID
name - der Name der angehängten Datei oder die Sitemap-Adresse
type – Dateiquellentyp (Textdatei oder Sitemap) – kann sein:
sitemap ,
text file
created_at – Erstellungsdatum
processing_date – Verarbeitungsdatum
has_error – ein Verarbeitungsfehler ist aufgetreten
error_message – Fehlermeldung
status – Status – kann sein:
pending (wartet auf Verarbeitung),
error (Verarbeitungsfehler),
success
is_pending – wird derzeit verarbeitet
is_success - erfolgreiche Verarbeitung
total_links – Gesamtzahl der gefundenen Links
added_links – Links hinzugefügt
invalid_links – ungültige Links
watch - Sitemap-Überwachungsstatus
google_access_granted – Ob der Zugriff auf ein Google-Konto gewährt wurde oder nicht
is_external_links – externe Links
search_engines - verbundene Suchmaschinen

Beispielimplementierung in PHP