API för marknadsföring

Marknadsförings-API:et ska alltid - och endast då - användas för kontroll vid marknadsföringsutskick (t.ex. e-post eller SMS) för att säkerställa att marknadsföring inte skickas direkt till en person som är avstängd i Spelpaus.se.

Detta API är uppdelat i två varianter; enskild förfrågan och mängdförfrågan. En mängdförfrågan kan innehålla upp till 10 000 personnummer.

Startsida

API för inloggning

Test-API

Enskild förfrågan

API:et anropas genom att skicka ett JSON-objekt med requestId och subjectId via HTTP POST till https://.../api/marketing-single-subjectid/{actorId}.

requestId är ett id som kommer skickas med i svaret på anropet. Unika requestID:n ska användas för varje förfrågan för att underlätta eventuell felsökning.
subjectId är personnumret på personen som ska kontrolleras.
actorId är ett unikt id som identifierar vilken licenshavare som anropar.

Svaret på anropet är ett JSON-objekt med följande fält:

isBlocked anger om personen är blockerad från att spela
requestId är samma id som skickades in i anropet
responseId är ett unikt id för anropet genererat av Test-API't

Exempel på anrop med olika verktyg

Powershell

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("authorization", "rxCzrck6ggsJPbb5YGdKLFs1LJmaMWPkKM3YJnl3vX6iakjArIhW6noOOzZH")
$headers.Add("Content-Type", "application/json")

$body = "{
`n  `"requestId`": `"string`",
`n  `"subjectId`": `"145301253042`"
`n}"

$response = Invoke-RestMethod 'https://testapi.spelpaus.se/api/marketing-single-subjectid/casino-test' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json

Curl

curl --location --request POST 'https://testapi.spelpaus.se/api/marketing-single-subjectid/casino-test' \
--header 'authorization: rxCzrck6ggsJPbb5YGdKLFs1LJmaMWPkKM3YJnl3vX6iakjArIhW6noOOzZH' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "requestId",
    "subjectId": "192905098717"
}'

RestSharp

var client = new RestClient("https://testapi.spelpaus.se/api/marketing-single-subjectid/casino-test");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("authorization", "rxCzrck6ggsJPbb5YGdKLFs1LJmaMWPkKM3YJnl3vX6iakjArIhW6noOOzZH");
request.AddHeader("Content-Type", "application/json");
var body = @"{
    ""requestId"": ""requestId"",
    ""subjectId"": ""192905098717""
}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Mängdförfrågan

API:et anropas genom att skicka ett JSON-objekt med requestId och subjectId via HTTP POST till https://.../api/marketing-subjectid/{actorId}.

Frågan ska innehålla requestId och en samling "items". Varje item består av itemId och subjectId.

requestId är ett unikt id som kommer skickas med i svaret på anropet. Unika requestID:n ska användas för varje förfrågan för att underlätta eventuell felsökning.
itemId är ett unikt id som sänds tillbaka via response till licenshavaren om personnumret är godkänt för marknadsföring.
subjectId är personnumret på en person som ska kontrolleras.
actorId är ett unikt id som identifierar vilken licenshavare som anropar.

Maximalt antal "items" i samma fråga är 10000.

Svaret på anropet är ett JSON-objekt med följande fält:

requestId är samma id som skickades in i anropet
responseId är ett unikt id för anropet genererat av API:et
allowedItemIds är en lista med godkända idn som motsvarar itemId i frågan. Observera att listan innehåller de som inte är blockerade.

Licenshavaren ansvarar för att personnumren är kopplade mot ett unikt ItemId eftersom personnummer inte returneras i svaret.

Powershell

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("authorization", "rxCzrck6ggsJPbb5YGdKLFs1LJmaMWPkKM3YJnl3vX6iakjArIhW6noOOzZH")
$headers.Add("Content-Type", "application/json")

$body = "{
`n    `"requestId`": `"myRequestId`",
`n    `"items`": [
`n        {
`n            `"itemId`": `"testsubject1`",
`n            `"subjectId`": `"145301253042`"
`n        },
`n        {
`n            `"itemId`": `"testsubject2`",
`n            `"subjectId`": `"143806056168`"
`n        },
`n        {
`n            `"itemId`": `"testsubject3`",
`n            `"subjectId`": `"195201282232`"
`n        },
`n        {
`n            `"itemId`": `"testsubject4`",
`n            `"subjectId`": `"195201282233`"
`n        }
`n    ]
`n}"

$response = Invoke-RestMethod 'https://testapi.spelpaus.se/api/marketing-subjectid/casino-test' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json

Curl

curl --location --request POST 'https://testapi.spelpaus.se/api/marketing-subjectid/casino-test' \
--header 'authorization: rxCzrck6ggsJPbb5YGdKLFs1LJmaMWPkKM3YJnl3vX6iakjArIhW6noOOzZH' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "requestId",
    "items": [
        {
            "itemId": "testsubject1",
            "subjectId": "145301253042"
        },
        {
            "itemId": "testsubject2",
            "subjectId": "143806056168"
        },
        {
            "itemId": "testsubject3",
            "subjectId": "195201282232"
        },
        {
            "itemId": "testsubject4",
            "subjectId": "195201282233"
        }
    ]
}'

RestSharp

var client = new RestClient("https://testapi.spelpaus.se/api/marketing-subjectid/casino-test");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("authorization", "rxCzrck6ggsJPbb5YGdKLFs1LJmaMWPkKM3YJnl3vX6iakjArIhW6noOOzZH");
request.AddHeader("Content-Type", "application/json");
var body = @"{
    ""requestId"": ""requestId"",
    ""items"": [
        {
            ""itemId"": ""testsubject1"",
            ""subjectId"": ""145301253042""
        },
        {
            ""itemId"": ""testsubject2"",
            ""subjectId"": ""143806056168""
        },
        {
            ""itemId"": ""testsubject3"",
            ""subjectId"": ""195201282232""
        },
        {
            ""itemId"": ""testsubject4"",
            ""subjectId"": ""195201282233""
        }
    ]
}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);