Keyword Discovery - API handleiding

Klik hier om toegang te krijgen tot de GRATIS, maar op beperkte API opties gebaseerde handleiding.

Het Keyword Research API (Application Programming Interface) biedt een aantal zoekopdrachtfuncties voor het Keyword Research databestand. Het API kan worden geïntegreerd in eigen specifieke toepassingen of worden gebruikt als een alternatieve interface.

Het API biedt functies voor het opsporen van data op enkele trefwoorden, meerdere trefwoorden van een enkele zoekopdracht en accountstatus controle. De zoekopdrachten retourneren alle data in XML formaat en de functies accepteren parameters zoals GET of POST waarden.

LET OP: Data aangeboden op een URL dient correct URL gecodeerd te zijn.

Inhoud

• Enkele Zoekopdracht
• Meervoudige Zoekopdrachten
• Spelling Zoekopdracht
• Gerelateerde Zoekopdracht
• Maandelijkse Zoek Tellingen
• Account Status
• Authenticatie
• Fout Codes
• Test Fouten

Deze functie werkt hetzelfde als de zoek functie op de Keyword Research website. Een zoekopdracht string bevat een zoekterm welke is verstuurd naar het databestand, welke een lijst van zoektermcombinaties retourneert die de originele zoekterm bevatten, tezamen met het totaal aantal zoekopdrachten, en het aantal maandelijkse zoekopdrachten. De zoekopdracht kan aangepast worden om zodoende data te retourneren via de parameters zoals hieronder weergegeven.

Parameters:

Zoekopdracht string/zoekterm (vereist)
Parameter naam: zoekopdracht
Aliassen: q, zoekopdracht
Beschrijving: De zoekterm waarop de zoekopdracht wordt uitgevoerd.


Offset
Parameter naam: offset
Aliassen: o, s, start, start_at
Standaard: 0
Maximum: 10,000
Waarden: integers 0 -> ..
Beschrijving: Het resultaten aantal waarop retournerende opnames dienen te worden gestart. b.v. offset=10 zal zoekresultaten retourneren beginnend met het 10de resultaat.


Beperking
Parameter naam: beperking
Aliassen: l, m, beperkt_tot, maximum
Standaard: 10
Maximum: 1000
Waarden: integers 1 -> 1000
Beschrijving: Het maximum aantal resultaten om te retourneren.


Compacte resultaten
Parameter naam: compact
Aliassen: c
Standaard: 1 (aan)
Waarden: 1,0 (aan,uit)
Beschrijving: Retourneert resultaten met afgekorte veldnaam beschrijvingen. b.v. totaal="1622" zal worden vertoond als t="1622".


Laat Totaal zien
Parameter naam: show_total
Standaard: nee
Waarden: ja (de zoekopdracht zal het totaal aantal resultaten laten zien als deze parameter is opgenomen in het adres, onafhankelijk van zijn waarden. Deze parameter in het geheel weglaten zal de zoekopdracht beletten om het totaalresultaat te tonen)
Beschrijving: Laat de totaal gevonden resultaten zien van de huidige zoekopdracht.

Resultaten

Resultaten worden geretourneerd als XML. Een simpele HTTP GET voorbeeld:

http://api.Keyword Discovery.com/query.php?query=airport+parking&offset=10&limit=15&show_total=yes

Dit verzoek is voor de zoekterm "airport parking", de zoekopdracht zal data tonen die begint bij het 10de resultaat, en een maximum van 15 resultaten zal worden geretourneerd. Als standaard, compacte resulten vertonen is aangezet. De XML die geretourneerd wordt door deze zoekopdracht is hieronder te zien:

<?xml version="1.0"?>
<results compact="true" maximum="15" offset="10" query="airport parking" total_found="14944">
  <r m="1028" q="airport parking, gatwick" t="2057" />
  <r m="144" q="dfw airport parking" t="1875" />
  <r m="117" q="airport car parking" t="1759" />
  <r m="122" q="manchester airport parking" t="1710" />
  <r m="135" q="airport parking gatwick" t="1628" />
  <r m="97" q="san diego airport parking" t="1360" />
  <r m="112" q="san jose airport parking" t="1346" />
  <r m="141" q="sacramento airport parking" t="1274" />
  <r m="104" q="seatac airport parking" t="1250" />
  <r m="79" q="logan airport parking" t="1187" />
  <r m="90" q="atlanta airport parking" t="1170" />
  <r m="93" q="detroit metro airport parking" t="1126" />
  <r m="76" q="heathrow airport parking" t="1072" />
  <r m="78" q="laguardia airport parking" t="1021" />
  <r m="66" q="midway airport parking" t="994" />
</results>

Elk resultaat wordt geretourneerd als een 'r' tag met de volgende attributen.

• q - query string
• t - totaal zoeken
• m - maandelijkse schatting

De enkele zoekopdracht functie is beschikbaar op de URL http://api.Keyword Discovery.com/query.php

LET OP: Data aangeboden op een URL dient correct URL gecodeerd te zijn.

De zoekopdrachten functie kan meerdere zoektermen in één keer accepteren, beperkt tot een maximum van 100, en retourneert het totaal aantal zoekopdrachten en het aantal maandelijkse zoekopdrachten voor elke zoekterm.

Parameters:

De hoofd parameter is de lijst van zoekopdrachten strings, één zin per regel.

zoekopdracht string (vereist)
Parameter naam: zoekopdracht
Aliassen: q, zoek, zoekopdrachten, zoekopdracht
Bestemming: Zoektermen gescheiden door nieuwe regel karakters
Beperking: Het aantal zoekopdrachten welke u kunt aanbieden in één keer is beperkt tot 100


Compact resultaten
Parameter naam: compact
Aliassen: c
Standaard: 1 (aan)
Waarden: 1,0 (aan,uit)
Beschrijving: Retourneert resultaten met afgekorte veldnaam beschrijvingen. B.v. totaal="1622" zal worden vertoond als t="1622"

Lege resultaten
Parameter naam: leeg
Aliassen: e
Standaard: 0 (uit)
Waarden: 1,0 (aan,uit)
Beschrijving: Retourneert resultaten welke geen overeenkomsten hebben. Als u een zoekopdracht aangeeft waarvoor we geen resultaten hebben, dan zal de uitkomst 0 worden geretourneerd.

Resultaten

Resultaten worden geretourneerd als XML. Een eenvoudig voorbeeld:
OPMERKING: de url is opgebroken in 2 regels voor meer duidelijkheid.

http://api.Keyword Discovery.com/queries.php?queries= \
airport+parking%0D%0Afree+web+hosting%0D%0Aweb+hosting%0D%0Afree+hosting

Dit verzoek is voor de zoektermen "airport parking","free web hosting","web hosting" en free hosting". Als standaard, compact resultaten vertonen is aangezet. De XML geretourneert voor deze zoekopdracht wordt hieronder getoond:

<?xml version="1.0"?>
<results compact="true" results="4">
<r m="1415771" q="web hosting" t="24068113"/>
<r m="62383" q="free web hosting" t="1060512"/>
<r m="28699" q="free hosting" t="487895"/>
<r m="3055" q="airport parking" t="51950"/>
</results>

Elk resultaat is geretourneerd als een 'r' tag met de volgende attributen:

• q - query string
• t - totale zoekopdracht
• m - maandelijkse schatting

Deze functie is beschikbaar op http://api.Keyword Discovery.com/queries.php

LET OP: Data aangeboden op een URL dient correct URL gecodeerd te zijn.

De spel functie zal een enkele zoekterm accepteren, en retourneert de dichtsbijzijnde termen welke ook in onze databestand zijn als ook als het aantal unieke zoekopdrachten waarin de term bestaat en het totaal aantal zoekopdrachten voor die opdrachten.

Parameters:

De hoofd parameter is de lijst van zoekopdrachten strings, één zin per regel.

Zoekopdracht string (vereist)
Parameter naam: zoekopdracht
Aliassen: q, zoeken
Beschrijving: Zoekterm


Compact resultaten
Parameter naam: compact
Aliassen: c
Standaard: 1 (aan)
Waarden: 1,0 (aan,uit)
Beschrijving: Retourneert resultaten met afgekorte veldnaam beschrijvingen. B.v. totaal="1622" zal worden vertoond als t="1622"

Resultaten

Resultaten worden geretourneerd als XML. Een eenvoudig voorbeeld:

http://api.Keyword Discovery.com/spell.php?query=accomidation&limit=15

Dit verzoek is voor de zoektermen "accomidation", een verkeerde spelling van "accommodation". De standaard soorteer orde is per totaal, zoekopdracht telling en tenslotte afstand. Als standaard, compact resultaten tonen is aangezet.

De XML geretourneert voor deze zoekopdracht wordt hieronder getoond:

<?xml version="1.0"?>
<results compact="true" distance="3" maximum="15" offset="0" query="accomidation" sort="tcd">
<r c="8295" d="2" t="1388850" w="accommodation"/>
<r c="2789" d="1" t="424794" w="accomodation"/>
<r c="1544" d="3" t="119103" w="accommodations"/>
<r c="1280" d="2" t="42956" w="accomodations"/>
<r c="338" d="1" t="12734" w="accomadation"/>
<r c="2" d="3" t="5263" w="accommadition"/>
<r c="150" d="3" t="2219" w="accumulation"/>
<r c="119" d="2" t="1688" w="accomadations"/>
<r c="49" d="2" t="863" w="accommadation"/>
<r c="46" d="1" t="529" w="accomidations"/>
<r c="37" d="0" t="488" w="accomidation"/>
<r c="5" d="2" t="380" w="accomedations"/>
<r c="15" d="1" t="256" w="accomdation"/>
<r c="56" d="3" t="170" w="accomodatie"/>
<r c="2" d="2" t="151" w="accomodatio"/>
</results>

Elk resultaat wordt geretourneerd als een 'r' tag met de volgende attributen:

• w - woord
• t - totale zoekopdrachten dat inclusief dit woord is
• c - totale zoekopdrachten dat inclusief dit woord is
• d - levenshtein afstand, een meting van het verschil tussen de zoekopdracht woord en dit woord

Deze functie is beschikbaar op http://api.Keyword Discovery.com/spell.php

LET OP: Data aangeboden op een URL dient correct URL gecodeerd te zijn.

De gerelateerde functie zal een zoekterm accepteren, en een lijst retourneren van termen vaak gerelateerd aan het originele zoekterm en het totaal aantal zoekopdrachten voor die zoekopdrachten.

Parameters:

De hoofd parameter is de lijst van zoekopdrachten strings, één zin per regel.

Zoekopdracht string (vereist)
Parameter naam: zoekopdracht
Aliassen: q, zoekopdracht
Beschrijving: Zoekterm


Compact resultaten
Parameter naam: compact
Aliassen: c
Standaard: 1 (aan)
Waarden: 1,0 (aan,uit)
Beschrijving: Retourneert resultaten met afgekorte veldnaam beschrijvingen. B.v. totaal="1622" zal worden vertoond als t="1622"

Resultaten

Resultaten worden geretourneerd als XML. Een eenvoudig voorbeeld:

http://api.Keyword Discovery.com/related.php?query=beer&limit=30

Dit verzoek is voor de gerelateerde zoektermen van "beer". De standaard soorteer orde is per relevantie naar de zoekopdracht. Als standaard, compact resultaten vertoning is aangezet.

De XML geretourneert voor deze zoekopdracht wordt hieronder getoond:

<?xml version="1.0"?>
<results compact="true" query="beer" results="30">
<r m="45024" q="beer" t="540583" />
<r m="901" q="ale" t="10820" />
<r m="526" q="brewery" t="6314" />
<r m="1233" q="brewing" t="14809" />
<r m="432" q="breweries" t="5186" />
<r m="222104" q="wine" t="2666715" />
<r m="754" q="lager" t="9047" />
<r m="51792" q="bar" t="621843" />
<r m="1669" q="homebrew" t="20040" />
<r m="63203" q="alcohol" t="758853" />
<r m="955" q="home brewing" t="11462" />
<r m="489" q="homebrewing" t="5869" />
<r m="1337" q="beers" t="16050" />
<r m="66" q="microbrewery" t="795" />
<r m="51" q="beer festivals" t="609" />
<r m="25" q="beer news" t="231" />
<r m="27872" q="drink" t="334646" />
<r m="1222" q="brew" t="14676" />
<r m="3646" q="pub" t="43778" />
<r m="1413" q="hops" t="16969" />
<r m="7549" q="budweiser" t="90643" />
<r m="355" q="tapping" t="4263" />
<r m="247" q="pilsner" t="2962" />
<r m="4" q="home draft beer" t="1" />
<r m="24" q="draft beer supplies" t="114" />
<r m="85" q="microbreweries" t="1023" />
<r m="56980" q="club" t="684136" />
<r m="732" q="stout" t="8794" />
<r m="749" q="home brew" t="8997" />
<r m="70" q="real ale" t="835" />
</results>

Elk resultaat wordt geretourneerd als een 'r' tag met de volgende attributen

• q - zoekopdracht string
• t - totale zoekopdracht
• m - maandelijkse schatting

Deze functie is beschikbaar als http://api.Keyword Discovery.com/related.php

LET OP: Data aangeboden op een URL dient correct URL gecodeerd te zijn.

Parameters:

Resultaten

Resultaten worden geretourneerd als XML. Een simpel voorbeeld:

http://api.Keyword Discovery.com/query.php?q=airport+parking&offset=10&limit=15&monthly=yes

Dit verzoek is voor de maandelijkse break down voor de zoektermen "airport parking".

De XML geretourneert voor deze zoekopdracht is hieronder getoond:

<results compact="true" maximum="15" offset="10" query="airport parking">
  <r Jan="120" Feb="126" Mar="840" m="5585" q="airport car parking" t="8047"/>
  <r Jan="1933" Feb="1531" Mar="1290" m="5283" q="newcastle airport car parking" t="7612"/>
  <r Jan="82" Feb="292" Mar="497" m="4342" q="atlanta airport parking" t="6256"/>
  <r Jan="1" Feb="0" Mar="591" m="3752" q="airport parking discounts" t="5406"/>
  <r Jan="43" Feb="281" Mar="530" m="3710" q="stansted airport parking" t="5346"/>
  <r Jan="309" Feb="166" Mar="451" m="3631" q="oakland airport parking" t="5231"/>
  <r Jan="143" Feb="103" Mar="462" m="3573" q="lax airport parking" t="5148"/>
  <r Jan="203" Feb="216" Mar="457" m="3543" q="jfk airport parking" t="5104"/>
  <r Jan="44" Feb="39" Mar="165" m="3325" q="los angeles airport parking" t="4791"/>
  <r Jan="130" Feb="145" Mar="503" m="3250" q="heathrow airport parking" t="4682"/>
  <r Jan="90" Feb="102" Mar="327" m="3175" q="birmingham airport parking" t="4574"/>
  <r Jan="153" Feb="84" Mar="375" m="2982" q="san jose airport parking" t="4296"/>
  <r Jan="173" Feb="131" Mar="386" m="2973" q="laguardia airport parking" t="4283"/>
  <r Jan="153" Feb="159" Mar="293" m="2773" q="minneapolis airport parking" t="3995"/>
  <r Jan="108" Feb="1186" Mar="259" m="2598" q="airport parking gatwick" t="3743"/>
</results>

Account status informatie kan worden opgezocht om account gebruiksdata te verkrijgen.

De volgende informatie is beschikbaar:

Vervallen - De datum dat het account zal vervallen (ook de datum dat de maandelijkse beperking eindigt)

Vernieuwen - Toont "t" (waar) als de account automatisch wordt vernieuwd, of f om aan te geven dat het om een niet automatische vernieuwing gaat. Als ingestelt op "t", het account zal automatisch worden gefactureerd voor de volgende maand op de verval datum.

Maandelijkse beperking - De maandelijkse zoekopdracht beperking van het account.

Zoekopdrachten - De huidige zoekopdracht gebruikt voor deze tijdsperiode.

Opgeschort - Vertoont "t" (waar) als de account is opgeschort, of om een actief account aan te geven. Accounts kunnen worden opgeschort vanwege misbruik.

Resultaten

Resultaten worden geretourneerd als XML. Een eenvoudig voorbeeld:

http://api.Keyword Discovery.com/status.php

Dit verzoek is voor de account status. De XML geretourneert voor deze zoekopdracht is hieronder te zien:

<?xml version="1.0"?>
<status expires="2004-12-18" monthly_allowance="10000" queries="64" renew="t" suspended="f" />

Deze functie is beschikbaar op http://api.Keyword Discovery.com/status.php

Autenticatie voor het API systeem wordt uitgevoerd met gebruik van standaard HTTP authenticatie. Wanneer een zoekopdracht wordt verstuurd via de API met gebruik van een webbrowser, dan verschijnt er een berichtbox waarin de accounthouder zijn gebruikersnaam en wachtwoord dient in te vullen om verder te gaan.

Authenticatie details kunnen ook worden verstuurd via de URL door de gebruikersnaam en wachtwoord in te voegen gescheiden door een kolom en suffixed met @, voor de hostnaam in de zoekopdracht URL.

LET OP: Onthoud dat data aangeboden via URL's correct URL gecodeerd dient te zijn.

OPMERKING: Microsoft Internet Explorer heeft de mogelijkheid om gebruikersnamen en paswoorden aan te bieden via de URL uitgeschakelt in recente versies van deze browser.
Dardoor is het niet mogelijk om deze functie te testen in Internet Explorer.

Een voorbeeld van het controleren van de accountstatus laat de URL autenticatie methode zien:

gebruikersnaam: user@host.com
paswoord: geheim

http://user%40host%2Ecom:secret@api.Keyword Discovery.com/status.php

Authenticatie mislukking zal een HTTP 401 retourneren: Ongeautoriseerd.

Alle foutmeldingen worden geretourneerd als XML.

Voorbeeld:

<?xml version="1.0"?>
<errors>
<error errorCode="400" errorString="Empty Query" />
</errors>

Foutcodes:

2XX	Databestand Fouten
Databestand fouten geven aan dat er een intern probleem was met het API systeem.
3XX	Account Beperking Fouten
300	Account maandelijkse Zoekopdracht Beperking is overschreden
301	Gebruiker Aangeboden Zoekopdrachten Beperking is overschreden
302	Account is opgeschort
303	Account is opgeschort
304	Account is in behandeling, verwerking afwachten
305	Toegang tot de Zoekopdracht functie is uitgezet
306	Toegang tot de Meerdere Zoekopdracht Functie is uitgezet
307	Toegang tot de Spel Functie is uitgezet
4XX	Gebruiker Input Fouten
400	Zoekopdracht String is Ongeldig
401	Offset waarden is Ongeldig
402	Maximum waarden is Ongeldig

Zoekopdrachten resulterend in fouten worden niet meegeteld in de maandelijkse zoekopdrachten toelating.

Indien u zelf de foutverwerking wenst uit te testen, kunt u een foutcode forceren om te worden geproduceerd. De 'error' parameter toevoegen aan een API zoekopdracht zal het systeem forceren om de geassocieerde fout te produceren. b.v. als u fout=400 hebt zal het systeem het volgende produceren:

<?xml version="1.0"?>
<errors>
<error errorCode="400" errorString="Empty Query" />
</errors>