Ištekliai kūrėjams

REST API žinynas

Integruokite masinį indeksavimo tikrinimą tiesiai į savo skydelius, įrankius ar scenarijus. Automatizuokite SEO procesą mūsų didelio pralaidumo API.

Trumpai

IndexChecker REST API leidžia iš savo scenarijų ir skydelių kurti tikrinimo projektus, skaityti jų indeksavimo būseną ir tikrinti kreditų likutį. Kiekviena užklausa autentifikuojama jūsų slaptu API raktu POST turinyje, galiniai taškai grąžina JSON, projektas priima iki 50 000 URL, o 1 kreditas patikrina 1 URL.

Autorius Adam Piersa, IndexChecker įkūrėjas Peržiūrėta ir atnaujinta

Kokius galinius taškus turi IndexChecker API?

Galinis taškasMetodasPaskirtis
/api/project/createPOSTSukurti tikrinimo projektą iš URL sąrašo
/api/project/showPOSTGauti projekto būseną, statistiką ir nuorodas
/api/project/show_allPOSTIšvardyti visus jūsų projektus
/api/project/deletePOSTVisam laikui ištrinti projektą
/api/check-balancePOSTGauti dabartinį kreditų likutį

Autentifikavimas

Autentifikuokite užklausas įtraukdami savo slaptą API raktą į užklausos turinį (POST parametrai).

Savo API raktą rasite ir valdysite skydelio nustatymuose.

Saugumo įspėjimas: Saugokite savo API raktą. Neviešinkite jo viešai prieinamame kode (pvz., kliento pusės JS).


POST

Sukurti projektą

Sukurkite naują tikrinimo projektą su URL sąrašu.

https://app.indexchecker.link/api/project/create
apikey privaloma string

Jūsų slaptas API raktas.

project_name privaloma string

Jūsų projekto pavadinimas.

urls privaloma string

URL sąrašas, atskirtas vertikaliu brūkšniu |.

description neprivaloma string
cURL pavyzdys POST
curl -X POST https://app.indexchecker.link/api/project/create \
  -d "apikey=YOUR_API_KEY" \
  -d "project_name=MyProject" \
  -d "urls=https://site1.com|https://site2.com"
Atsakymas 200 OK
{
  "error": 0,
  "message": "project MyProject has been added in it 2 links.",
  "project_name": "MyProject",
  "procjet_id": 154,
  "project_id": 154,
  "add_links_count": 2
}

POST

Gauti projekto informaciją

Gaukite konkretaus projekto būseną, statistiką ir nuorodas.

https://app.indexchecker.link/api/project/show
apikey privaloma
project_id privaloma int

Projekto, kurį norite gauti, ID.

Atsakymas 200 OK
{
  "project_name": "MyProject",
  "description": "optional description",
  "date_created": "2023-10-12 14:30:00",
  "project_id": "154",
  "urls": {
    "https://site1.com": "1",
    "https://site2.com": "-1"
  },
  "statistics": {
    "total_links": 2,
    "indexed": 1,
    "not_indexed": 0,
    "pending": 1,
    "percentage": 50
  }
}
* Būsenos kodai: 1 (indeksuota), 0 (neindeksuota), -1 (laukiama patikros)

POST

Visų projektų sąrašas

Gaukite visų savo projektų sąrašą.

https://app.indexchecker.link/api/project/show_all
apikey privaloma
Atsakymas
{
  "154": {
    "project_name": "MyProject",
    "description": "",
    "date_created": "2023-10-12 14:30:00"
  },
  "155": {
    "project_name": "Another Project",
    "description": "SEO Audit",
    "date_created": "2023-10-13 09:15:00"
  }
}

POST

Ištrinti projektą

Visam laikui pašalinkite projektą ir visus susijusius duomenis.

https://app.indexchecker.link/api/project/delete
apikey privaloma
project_id privaloma

Trintino projekto ID.

Atsakymas
{
  "id": "154",
  "error": 0,
  "message": "The MyProject project has been deleted"
}

POST

Patikrinti likutį

Gaukite savo dabartinį kreditų limitą.

https://app.indexchecker.link/api/check-balance
apikey privaloma
Atsakymas 200 OK
{
  "limit": 4500,
  "error": 0
}

Dažni klausimai

Kaip autentifikuoti API užklausas?

Kiekvienos užklausos POST turinyje nurodykite savo slaptą API raktą kaip parametrą apikey. Raktą rasite ir valdysite skydelio nustatymuose.

Kiek URL gali turėti vienas API projektas?

Iki 50 000 URL viename projekte, tiek pat kiek skydelyje. Kurdami projektą, parametre urls atskirkite juos vertikaliu brūkšniu.

Kiek kainuoja patikra per API?

1 kreditas už patikrintą URL, įskaitant pakartotinę patikrą antrame duomenų centre. Kreditai niekada nebaigia galioti, o API prieiga įtraukta į kiekvieną paketą, pradedant nemokama bandomąja versija.

Kokiu formatu atsako API?

JSON formatu. Kiekvienas galinis taškas grąžina lauką error, kuris sėkmės atveju lygus 0, ir projekto duomenis: būseną, statistiką ir, kai taikoma, indeksavimo rezultatą kiekvienam URL.

IndexChecker yra masinio Google indeksavimo tikrinimo įrankis, kurį valdo AP2Media Sp. z o.o., ES registruota bendrovė, įsikūrusi Czerwine, Lenkijoje (PVM kodas PL7582396091). Jis naudojamas gamybinėje aplinkoje pačios bendrovės SEO projektuose, įskaitant vietinio SEO paslaugą drukujemy3d.pl, ir per pastarąsias 30 dienų savo klientams patikrino daugiau nei du milijonus URL.