Tovább a tartalomhoz

Kiegészítők végpontjai

A kiegészítők REST API-végpontjai: Comments, SSL Monitor, Domain Monitor, Lighthouse, Pro Reports és Time Tracker.

A kiegészítők végpontjai a MainWP-kiegészítők funkcióit érik el. Ezek az útvonalak csak akkor válaszolnak, ha a megfelelő kiegészítő telepítve és aktív a vezérlőpulton. A pontos kérés- és válaszszerkezetet a Postman-gyűjtemény és az OpenAPI-leírás adja, ahol ezeket az útvonalakat x-requires-extension jelölés látja el.

A {id_or_domain} a webhely számazonosítóját vagy domainjét fogadja el.

Metódus Útvonal Mire jó Fő paraméterek
GET /comments Hozzászólások a kiválasztott webhelyeken websites, groups, clients, status, keyword, dtsstart, dtsstop, maximum
GET /comments/{id_or_domain} Egy webhely hozzászólásai status, keyword, dtsstart, dtsstop, maximum
PUT, PATCH /comments/{id_or_domain}/{id_comment}/action Művelet egy hozzászóláson action
PUT, PATCH /comments/{id_or_domain}/bulk-action Művelet több hozzászóláson action, comment_ids
  • Az action lehetséges értékei: approve, unapprove, spam, unspam, trash, restore, delete.
  • A status szűrő értékei: approved, pending, spam, trash, all (alapértelmezés: all).
  • A maximum webhelyenként korlátozza a visszaadott hozzászólások számát (alapérték 50, legfeljebb 500).
Terminál
curl -H "Authorization: Bearer API_KULCS" \
"https://a-te-vezerlopultod.hu/wp-json/mainwp/v2/comments?status=pending&websites=12,19&maximum=50"
{
"success": 1,
"message": "Comments retrieved successfully.",
"data": {
"https://pelda.hu": [
{
"comment_id": 482,
"comment_author": "Minta Anna",
"comment_content": "Remek cikk!",
"comment_status": "pending",
"post_id": 341,
"post_title": "Negyedéves jelentés",
"website_id": 12,
"website_url": "https://pelda.hu",
"website_name": "Minta webhely"
}
]
}
}

Egy hozzászólás jóváhagyása:

Terminál
curl -X PUT \
-H "Authorization: Bearer API_KULCS" \
-H "Content-Type: application/json" \
-d '{ "action": "approve" }' \
"https://a-te-vezerlopultod.hu/wp-json/mainwp/v2/comments/12/482/action"

Több hozzászólás kukába helyezése egy webhelyen:

Terminál
curl -X PUT \
-H "Authorization: Bearer API_KULCS" \
-H "Content-Type: application/json" \
-d '{ "action": "trash", "comment_ids": "482,483,491" }' \
"https://a-te-vezerlopultod.hu/wp-json/mainwp/v2/comments/12/bulk-action"
Metódus Útvonal Mire jó
GET /ssl-monitor/info Az összes figyelt webhely SSL-állapota
GET /ssl-monitor/info/{id_or_domain} Egy webhely SSL-állapota
POST, PUT, PATCH /ssl-monitor/{id_or_domain} SSL-ellenőrzés indítása egy webhelyen
Terminál
curl -X POST \
-H "Authorization: Bearer API_KULCS" \
"https://a-te-vezerlopultod.hu/wp-json/mainwp/v2/ssl-monitor/12"
Metódus Útvonal Mire jó
GET /domain-monitor/profiles Az összes figyelt webhely domainprofilja
GET /domain-monitor/profiles/{id_or_domain} Egy webhely domainprofilja
POST, PUT, PATCH /domain-monitor/{id_or_domain} Domainellenőrzés indítása egy webhelyen
Terminál
curl -H "Authorization: Bearer API_KULCS" \
"https://a-te-vezerlopultod.hu/wp-json/mainwp/v2/domain-monitor/profiles/12"
Metódus Útvonal Mire jó Fő paraméterek
POST, PUT, PATCH /lighthouse/audit Lighthouse-vizsgálat az összes támogatott webhelyen
POST, PUT, PATCH /lighthouse/audit/{id_or_domain} Vizsgálat egy webhelyen
GET /lighthouse/results Az összes webhely eredményei Opcionális szűrők
GET /lighthouse/results/{id_or_domain} Egy webhely eredményei
Terminál
curl -X POST \
-H "Authorization: Bearer API_KULCS" \
"https://a-te-vezerlopultod.hu/wp-json/mainwp/v2/lighthouse/audit"

A Pro Reports útvonalak közös lekérdezési paraméterei:

Név Típus Kötelező Leírás
start_date szöveg Nem Kezdő dátum Y-m-d formátumban. Ha bármelyik dátum hiányzik, a tartomány az utolsó évre áll be
end_date szöveg Nem Záró dátum Y-m-d formátumban. Ha bármelyik dátum hiányzik, a tartomány az utolsó évre áll be
action szöveg Nem Tevékenységszűrő (útvonalfüggő)
format szöveg Nem A válasz formátuma
multi_tokens szöveg Csak a multi-tokens útvonalon A jelentéssablon tartalma, amelynek tokenjeit (például [client.name]) a vezérlőpult feloldja

Minden útvonal GET metódusú, /pro-reports/{id_or_domain}/… alakú:

Útvonal vége Tartalom
plugins Bővítménytevékenység
themes Tématevékenység
wordpress WordPress-mag tevékenység
posts Bejegyzéstevékenység
pages Oldaltevékenység
users Felhasználói tevékenység
comments Hozzászólás-tevékenység
menus Menütevékenység
media Médiatevékenység
widgets Widgettevékenység
backups Mentési tevékenység
maintenance Karbantartási tevékenység
sucuri Sucuri-vizsgálatok
wordfence Wordfence-vizsgálatok
ithemes Solid Security/iThemes tevékenység
virusdie Virusdie tevékenység
domainmonitor Domain Monitor tevékenység
sslmonitor SSL Monitor tevékenység
pagespeed Page Speed tevékenység
woocomstatus WooCommerce-állapot tevékenység
vulnerable Sebezhetőségi tevékenység
ga Google Analytics
matomo Matomo analitika
lighthouse Lighthouse-teljesítmény
aum Advanced Uptime Monitor
uptime Rendelkezésre állás
atarim Atarim tevékenység
protect Jetpack Protect
scan Jetpack Scan
website Webhely összesítő mérőszámai
abandoned Elhagyott bővítmény- és témaadatok
pending Függő frissítések
misc Egyéb jelentésadatok
multi-tokens Egy sablon feloldott tokenjei

Google Analytics adatok lekérése:

Terminál
curl -H "Authorization: Bearer API_KULCS" \
"https://a-te-vezerlopultod.hu/wp-json/mainwp/v2/pro-reports/12/ga?start_date=2024-01-01&end_date=2024-01-31"

A {id_or_email} az ügyfél azonosítóját vagy e-mail-címét fogadja el.

Metódus Útvonal Mire jó Fő paraméterek
GET /time-tracker Feladatok listázása Opcionális dátum- és állapotszűrők
GET /time-tracker/settings Time Tracker beállításai
GET /time-tracker/tasks/{task_id} Feladat lekérése azonosító alapján task_id
POST /time-tracker/tasks/add Feladat létrehozása Feladatmezők
PUT /time-tracker/tasks/{task_id}/edit Feladat szerkesztése task_id, szerkeszthető feladatmezők
POST /time-tracker/tasks/{task_id}/start Feladat időmérőjének indítása task_id
POST /time-tracker/tasks/{task_id}/pause Időmérő szüneteltetése task_id
POST /time-tracker/tasks/{task_id}/stop Időmérő leállítása task_id
GET /time-tracker/clients A Time Trackerben szereplő ügyfelek Opcionális szűrők
GET /time-tracker/clients/{id_or_email} Egy ügyfél adatai
GET /time-tracker/clients/{id_or_email}/settings Az ügyfél Time Tracker beállításai
GET /time-tracker/clients/{id_or_email}/tasks Az ügyfél feladatai
GET /time-tracker/clients/{id_or_email}/buckets Az ügyfél keretei (bucket)
GET /time-tracker/sites/{id_or_domain}/tasks Egy webhely feladatai
GET /time-tracker/buckets Keretek listázása Opcionális szűrők
GET /time-tracker/buckets/{bucket_id} Egy keret adatai bucket_id

Feladat időmérőjének indítása:

Terminál
curl -X POST \
-H "Authorization: Bearer API_KULCS" \
"https://a-te-vezerlopultod.hu/wp-json/mainwp/v2/time-tracker/tasks/44/start"

Készült:

Tiszteletben tartjuk a magánszférádat

Sütiket használunk a böngészési élmény javítására és a forgalom elemzésére. Az analitika csak akkor indul, ha engeded. Adatvédelmi irányelvek, Sütitájékoztató.

Sütibeállítások