API Dokumentaiton
Sådan får du adgang til Robinsonlisten API
- Opret en bruger på robinsonlistenapi.dk ved at klikke på "Køb adgang" knappen på forsiden.
- Udfyld de nødvendige oplysninger i oprettelsesformularen, herunder din emailadresse.
- Når du har oprettet en bruger, vil du modtage en email med din API nøgle.
Brug din API nøgle i dit API kald ved at inkludere den i parameteren api_key som vist i eksemplet nedenfor:
fetch(
'https://robinsonlistenapi.dk/api/v1/identifications',
{
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({
search: [
{ query: 'Marcus Jensen' },
{ query: 'Flakholmen 14 st. th.', id: 1 },
{ first_name: 'Hans', last_name: 'Schøller', id: 203 },
{ phone_number: '+4512344321' }
],
api_key: ''
})
}
)
.then(response => response.json())
.then(data => { console.log(data); return data; });
fetch(
'https://robinsonlistenapi.dk/api/v1/identifications?' +
new URLSearchParams({
search: 'Marcus Jensen',
api_key: ''
})
)
.then(response => response.json())
.then(data => { console.log(data); return data; });
require 'net/http'
require 'uri'
uri = URI.parse('https://robinsonlistenapi.dk/api/v1/identifications')
params = { search: 'Marcus Jensen', api_key: '' }
uri.query = URI.encode_www_form(params)
response = Net::HTTP.get_response(uri)
data = JSON.parse(response.body)
puts data
require 'net/http'
require 'json'
uri = URI('https://robinsonlistenapi.dk/api/v1/identifications')
request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
request.body = JSON.dump({
search: [
{ query: 'Marcus Jensen' },
{ query: 'Flakholmen 14 st. th.', "id": 1, },
{ first_name: 'Hans', last_name: 'Schøller', "id": 203, },
{ phone_number: '+4512344321' }
],
api_key: ''
})
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
response_data = JSON.parse(response.body)
puts response_data
curl -X GET \
'https://robinsonlistenapi.dk/api/v1/identifications?search=Marcus%20Jensen&api_key='
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://robinsonlistenapi.dk/api/v1/identifications?search=Marcus%20Jensen&api_key=',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
));
$response = curl_exec($curl);
$data = json_decode
import requests
params = {
"search": "Marcus Jensen",
"api_key": ""
}
response = requests.get("https://robinsonlistenapi.dk/api/v1/identifications", params=params)
data = response.json()
print(data)
Med din API nøgle kan du nu benytte Robinsonlisten API til at kontrollere om en person er på robinsonlisten. Du kan se eksempler på svar fra API'et nedenfor:
[
{
"query": "Marcus Jensen",
"result": {
"robinsonlisten": "1",
"robinson_matched_on": "first_name, last_name",
"robinson_match_attempts": "first_name, last_name, address"
}
},
{
"query": "Flakholmen 14 st. th.",
"id": 1,
"result": {
"robinsonlisten": "1",
"robinson_matched_on": "address",
"robinson_match_attempts": "first_name, last_name, address"
}
},
{
"first_name": "Ole",
"last_name": "Schøller",
"id": 203,
"result": {
"robinsonlisten": "0",
"robinson_match_attempts": "first_name, last_name, address, phone"
}
},
{
"phone_number": "+4512344321",
"result": {
"robinsonlisten": "1",
"robinson_matched_on": "first_name, last_name, address",
"robinson_match_attempts": "first_name, last_name, address",
"phone_lookup_data": {
"first_name": "Marcus",
"last_name": "Jensen",
"address": "Flakholmen 14 st. th."
}
}
}
]
[
{
"query": "Marcus Jensen",
"result": {
"robinsonlisten": "1",
"robinson_matched_on": "first_name, last_name",
"robinson_match_attempts": "first_name, last_name, address"
}
}
]
Når Robinsonlisten API returnerer et svar på et søgeforespørgsel, giver det en liste af resultater, hver med en række felter. Her er en forklaring af de vigtigste felter i et resultat:
- "query": Dette felt indeholder den søgning, der blev foretaget. Hvis der blev søgt efter en persons navn, vil dette felt indeholde navnet. Hvis der blev søgt efter en adresse, vil dette felt indeholde adressen.
- "result": Dette felt indeholder resultaterne af søgningen. Det vil altid indeholde to felter: "robinsonlisten" og "robinson_match_attempts".
- "robinsonlisten": Dette felt angiver, om den søgte person er på Robinsonlisten eller ej. Hvis værdien er "1", betyder det, at personen er på Robinsonlisten, mens en værdi på "0" betyder, at personen ikke er på Robinsonlisten.
- "robinson_match_attempts": Dette felt angiver, hvilke felter der blev brugt til at foretage søgningen. For eksempel, hvis der blev søgt efter et navn, vil dette felt indeholde "first_name, last_name". Hvis der blev søgt efter en adresse, vil dette felt indeholde "address".
- "robinson_matched_on": Dette felt angiver, hvilke felter der matchede i søgningen. Hvis der blev søgt efter et navn, og navnet matchede, vil dette felt indeholde "first_name, last_name". Hvis der blev søgt efter en adresse, og adressen matchede, vil dette felt indeholde "address".
- "phone_lookup_data": Dette felt vises kun, hvis der blev søgt efter et telefonnummer. Det indeholder oplysninger om personen, der ejes af det søgte telefonnummer, såsom navn og adresse.
Således giver Robinsonlisten API en liste af resultater for hver søgning, med felter, der giver oplysninger om, om personen er på Robinsonlisten, hvilke felter der blev brugt til at søge, og hvilke felter der matchede. Derudover kan der være yderligere oplysninger om den søgte person, såsom navn og adresse, hvis der blev søgt efter et telefonnummer.
Se eventuelt dette overblik over strukturen:
{
"query": "Input streng",
"result": {
"robinsonlisten": "1 eller 0 afhængigt af om personen er på robinsonlisten",
"robinson_matched_on": "Hvilke oplysninger der blev brugt til at matche personen (f.eks. 'first_name, last_name')",
"robinson_match_attempts": "Hvilke oplysninger der blev brugt i søgningen (f.eks. 'first_name, last_name, address')",
"phone_lookup_data": {
"first_name": "Fornavn for personen, hvis fundet gennem telefonnummer opslag",
"last_name": "Efternavn for personen, hvis fundet gennem telefonnummer opslag",
"address": "Adresse for personen, hvis fundet gennem telefonnummer opslag"
}
}
}
For eksempel betyder dette svar:
[
{
"query": "Marcus Jensen",
"result": {
"robinsonlisten": "1",
"robinson_matched_on": "first_name, last_name",
"robinson_match_attempts": "first_name, last_name, address"
}
}
]
At søgningen på "Marcus Jensen" returnerede et hit, da navnet matchede en person på robinsonlisten. Oplysningerne "first_name" og "last_name" blev brugt til at matche personen, og "first_name", "last_name" og "address" blev brugt i søgningen.