Skip to navigation

Je eerste API-aanroep doen

De snelste manier om te zien of alles werkt, is het opvragen van je lijsten. Die aanroep verandert niets aan je account en geeft meteen antwoord. Je kunt deze aanroep hier op de site doen of vanaf je eigen computer.

Aanroep doen via deze site

1

Maak een API-sleutel aan

Maak in je account een sleutel aan onder ‘Koppelingen’. Een nieuwe sleutel is maar één keer zichtbaar, dus bewaar hem meteen. Zie: API-sleutel aanmaken.

2

Open het endpoint

Ga naar Alle lijsten opvragen.

3

Vul je sleutel in en verstuur

Klik rechts bij het codevoorbeeld op ‘Try it’ en vul je sleutel in bij ‘api_key’. Klik daarna op versturen. Meer over dit veld en deze knop lees je bij API uitproberen met Try it.

4

Lees het antwoord

Je krijgt een 200-antwoord met al je lijsten in data. Het list_id dat je daar ziet, heb je bij bijna elke andere aanroep nodig.

Je doet hiermee een echte aanroep. Hoe je veilig test, staat bij API uitproberen met Try it.

Aanroep doen vanaf je eigen systeem

Hoe je je sleutel meestuurt, lees je bij Authenticatie met je API-sleutel.

curl
curl https://api.laposta.nl/v2/list \
-u JOUW_API_SLEUTEL:

Met de PHP-bibliotheek is dat:

PHP
$laposta = new Laposta('JOUW_API_SLEUTEL');
$lijsten = $laposta->listApi()->all();

Een antwoord ziet er zo uit, ingekort tot één lijst:

{
"data": [
{
"list": {
"list_id": "BaImMu3JZA",
"name": "Nieuwsbrief",
"state": "active",
"members": { "active": 1232, "unsubscribed": 113, "cleaned": 14 }
}
}
]
}

Een relatie toevoegen

De aanroep die je daarna waarschijnlijk nodig hebt, is het toevoegen van een relatie. Naast het e-mailadres is het IP-adres verplicht, want daarmee leg je vast waar de aanmelding vandaan kwam.

curl
curl https://api.laposta.nl/v2/member \
-u JOUW_API_SLEUTEL: \
-d list_id=BaImMu3JZA \
-d ip=198.51.100.10 \
-d email=nieuwe.relatie@example.net \
-d custom_fields[voornaam]=Sanne
PHP
$laposta->memberApi()->create('BaImMu3JZA', [
'ip' => '198.51.100.10',
'email' => 'nieuwe.relatie@example.net',
'custom_fields' => ['voornaam' => 'Sanne'],
]);

De sleutels binnen custom_fields zijn de custom_name van je eigen velden. Die kun je eenmalig ophalen met Alle velden opvragen en in je eigen code bewaren.

Gerelateerde artikelen