Documentazione API

Indirizzo API: https://2index.ninja/api/v1/

Per effettuare una richiesta all'API, è necessario passare il token di accesso Bearer nell'intestazione Authorization.

 Il token di accesso può essere ottenuto dall'appropriato curl https://2index.ninja/api/v1/account -H "Authorization: Bearer API_TOKEN"

sezione nell'account utente.

La risposta a ciascuna richiesta contiene un parametro success , che determina il successo della richiesta. Il parametro errors contiene i messaggi di errore.

In alcuni casi, se viene restituito un errore 403, è necessario specificare l'agente utente, ad esempio:

 Le richieste potrebbero essere limitate dal provider di hosting, in tal caso consigliamo di utilizzare un proxy. 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"

Metodi per lavorare con un account

Ottieni i dettagli dell'account

È necessario eseguire una richiesta GET all'indirizzo account

 La risposta conterrà dati in formato JSON: 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" } } Metodi per lavorare con i progetti { "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" } } 

Ottieni un elenco di progetti

È necessario eseguire una richiesta GET all'indirizzo project

 La risposta conterrà dati in formato JSON: 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", } ... ] } Ottieni i dati del progetto { "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", } ... ] }

Devi effettuare una richiesta GET all'indirizzo project/{project_id}

 La risposta conterrà dati in formato JSON: GET https://2index.ninja/api/v1/project/1

• Per il progetto di indicizzazione:

 { "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" } } Per il progetto di verifica dell'indicizzazione: { "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" } } Crea un progetto { "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" } }

È necessario eseguire una richiesta POST all'indirizzo project

 Parametri della richiesta: POST https://2index.ninja/api/v1/project

** Quando si crea un progetto di qualsiasi tipo, è possibile utilizzare i parametri indexing_speed o checking_speed ; sono alias l'uno dell'altro, ma se vengono passati entrambi, verrà utilizzato indexing_speed .

La risposta conterrà dati in formato JSON:

 { "success": true, "message": "The project has been successfully created" } Un esempio di creazione di un progetto di indicizzazione dei link: { "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 Un esempio di creazione di un progetto di controllo dell'indicizzazione dei link: 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 Cancella la coda di indicizzazione name: Project 2 checking_speed: 100

Devi effettuare una richiesta POST a project/{project_id}/clear_queue

 La risposta conterrà dati in formato JSON: 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" } Oppure verrà restituito il messaggio di errore corrispondente: { "success": true, "message": "The indexing queue has been cleared successfully. X links have been removed" }

 { "success": false, "errors": ["Project not found"] } Metodi per lavorare con i link { "success": false, "errors": ["Project not found"] } 

Aggiungi link

Devi effettuare una richiesta POST all'indirizzo link/add

 Parametri della richiesta: POST https://2index.ninja/api/v1/link/add

La risposta conterrà dati in formato JSON:

 { "success": true, "message": "Links have been successfully added to the project" } Se nell'elenco sono presenti link non validi, i link non verranno aggiunti e verrà visualizzato un messaggio di errore corrispondente in risposta: { "success": true, "message": "Links have been successfully added to the project" }

 { "success": false, "errors": ["You sent invalid links"], "invalid_links": ["http://wrong.link"] } Per progetti { "success": false, "errors": ["You sent invalid links"], "invalid_links": ["http://wrong.link"] }

I controlli di indicizzazione dei link vengono aggiunti allo stesso modo dell'indicizzazione. google_access_granted è facoltativo e verrà ignorato. È necessario specificare i motori di ricerca, ma al momento sono disponibili solo le ricerche Google.

Aggiungi link in base al nome del progetto

È necessario effettuare una richiesta POST a link/add_simple . Se un progetto con il nome specificato non esiste, verrà creato automaticamente alla massima velocità di caricamento.

 Parametri della richiesta: POST https://2index.ninja/api/v1/link/add_simple

Per i progetti di verifica dell'indice , i link vengono aggiunti allo stesso modo dell'indicizzazione. google_access_granted è facoltativo e verrà ignorato. È necessario specificare i motori di ricerca, ma la verifica è attualmente disponibile solo per Google.

Esempio di richiesta:

 { "project_name": "My Website", "links": ["https://example.com/page1", "https://example.com/page2"], "google": true, "yandex": false, "bing": true, "google_access_granted": false } Risposta in caso di successo: { "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 } Possibili errori: { "success": true, "message": "Links have been successfully added to the project", "project_name": "My Website", "project_id": 12345 }

• Se nell'elenco sono presenti link errati:

 { "success": false, "errors": ["You sent invalid links"], "invalid_links": ["http://wrong.link"] } Se si è verificato un errore durante la creazione di un progetto: { "success": false, "errors": ["You sent invalid links"], "invalid_links": ["http://wrong.link"] }

 { "success": false, "errors": ["Failed to create the project"] } Controlla lo stato del collegamento { "success": false, "errors": ["Failed to create the project"] } 

Eseguire una richiesta POST all'indirizzo   /api/v1/link/status

 Parametri della richiesta: POST https://2index.ninja/api/v1/link/status 

• Se la richiesta ha esito positivo, verrà ricevuto in risposta un oggetto json:

 { "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" } } Dove: { "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" } } 

* Possibili stati:

• Se si verifica un errore, verrà restituito un oggetto JSON con il messaggio di errore. Esempi di errori:

 { "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" ] } Puoi anche ottenere lo stato del collegamento tramite ID collegamento { "success" : false , "errors" : [ "URL not found" ] } 

Per fare ciò, eseguire una richiesta GET all'indirizzo   /api/v1/link/status/ID

 La risposta alla richiesta sarà la stessa della versione precedente. GET https://2index.ninja/api/v1/link/status/ID

Lavorare con fonti di riferimento

Le fonti dei link sono disponibili per tutti i tipi di progetto e vengono elaborate in modo identico. Per i progetti di controllo dell'indice, è disponibile solo Google.

Aggiungere una mappa del sito

Effettua una richiesta POST a /api/v1/sitemap/add

 Parametri della richiesta: POST https://2index.ninja/api/v1/sitemap/add

Possibili errori:

Esempi di risposte:

Mappa del sito aggiunta correttamente:

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

 { "errors": ["sitemap":["The sitemap field is required."]] } Progetto non trovato: { "errors": ["sitemap":["The sitemap field is required."]] }

 { "errors": ["Project not found"] } Aggiornamento dello stato di tracciamento della mappa del sito { "errors": ["Project not found"] } 

Invia una richiesta POST a /api/v1/sitemap/update_watch

 Parametri della richiesta: POST https://2index.ninja/api/v1/sitemap/update_watch

Possibili errori:

Esempi di risposte:

Aggiornamento riuscito dello stato di tracciamento:

 { "success": true } Collegamento sorgente non trovato: { "success": true }

 { "errors": ["Link source not found"] } Rimozione di un collegamento sorgente { "errors": ["Link source not found"] }

Effettua una richiesta POST a /api/v1/sitemap/delete

 Parametri della richiesta: POST https://2index.ninja/api/v1/sitemap/delete

Possibili errori:

Esempi di risposte:

Rimozione riuscita del collegamento sorgente:

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

 { "errors": ["Project not found"] } Elenco delle fonti di riferimento { "errors": ["Project not found"] }

Per ottenere un elenco delle fonti di link aggiunte, è necessario effettuare una richiesta POST a https://2index.ninja/api/v1/link_sources

Passa project_id nella richiesta

Verrà restituito il seguente set di dati:

 [ { "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 } } ] Dove [ { "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 della sorgente del collegamento
project_id - ID del progetto
name - il nome del file allegato o l'indirizzo della mappa del sito
type - tipo di origine del file (file di testo o mappa del sito) - può essere:
sitemap ,
text file
created_at - data di creazione
processing_date - data di elaborazione
has_error - si è verificato un errore di elaborazione
error_message - messaggio di errore
status - stato - può essere:
pending attesa di elaborazione,
error (errore di elaborazione),
success
is_pending - attualmente in fase di elaborazione
is_success - elaborazione riuscita
total_links - numero totale di link trovati
added_links - link aggiunti
invalid_links - link non validi
watch - stato di monitoraggio della mappa del sito
google_access_granted - Indica se l'accesso a un account Google è stato concesso o meno
is_external_links - link esterni
search_engines - motori di ricerca connessi

Esempio di implementazione in PHP