API

Teknisk dokumentation

Viktig information!
Inom kort kommer det att krävas en API-nyckel för Sök. Den är gratis och erhålles genom att skicka mig ett e-postmeddelande.
Har du redan en nyckel kommer den att fungera, skicka med den som vanligt.
Anledningen är att jag vill ha mer koll vilka som använder API:et samt snabbare kunna delge information när förändringar sker.

Version 2 av vårat API ger dig tillgång till data om ett telefonnummer genom ett enkelt REST-anrop.
Du anropar alltid mot http://api.missatsamtal.se

APi:et är uppdelat i tre delar, sök, lista och posta. Sök används för att hämta data, lista hämtar de x vanligaste numren och företagen och Posta när du vill lägga till data till ett telefonnummer.
Posta kräver en api-nyckel vilket du erhåller genom att kontakta oss och berätta om ditt syfte.

Sök

Parametrar (get eller post)
action (search) format (json, xml) standard json
number
numberOfCompanies (1,2,3,4)

Exempel
http://api.missatsamtal.se/?action=search&format=xml&number=0454760200&numberOfCompanies=1
Hämtar data för telefonnummer 0454760200, visar det företag som mest förknippats med detta nummer och returnerar data som xml.

Svar
data/number - numret du sökte efter
data/comments - totalt antal kommentarer
data/companies/ - de numberOfCompanies mest angivna företagen
data/companies/company/name - namn på företaget
data/companies/company/comments - antal kommentarer som angett detta företag

Lista

Parametrar (get eller post)
action (list)
format (json, xml) standard json
limit (max 500)

Exempel
http://api.missatsamtal.se/?action=list&format=xml&limit=10
Hämtar de 500 vanligast förekommande numren med tillhörande företag.

Svar
data/company/number - numret
data/company/name - tillhörande namn, Telefonförsäljare om vi ej vet namnet

Posta

Parametrar (post)
action (post)
format (json, xml) standard json
number - endast siffror (måste anges)
company - vilket företag som ringde (måste anges)
comment - kommentar (måste anges)
key - erhåller genom kontakt, se ovan
test - anges bara vid testning, innebär att data ej sparas hos oss

Svar
data/error - Vid fel data/ok - Allt ok

Tipsa oss gärna om du haft nytta utav vårat API, vad har du använt det till?

Gamla API:et (deprecated)

Nedanstående kommer att fasas ut, undvik att använda detta och byt till det nya ovan.
Saknar du någon data via det nya API:et hör av dig till oss så fixar vi det.

numCalls Minsta antalet inrapporterade samtal (Giltiga värden är alla positiva heltal)
numDays Längsta tidsperiod (Giltiga värden är alla positiva heltal)
output Anger format man får data i (Giltiga värden är text eller asterix)

Exempel

Följande hämtar alla telefonnummer som har fått minst 3 rapporter under de senaste 60 dagarna och matar ut det i ett format som kan användas till Asterisk.
http://www.missatsamtal.se/api/?numCalls=3&numDays=60&output=asterisk