Dit artikel is voor de webbouwer die het aanmeldformulier koppelt. Je website stuurt de aanmelding vanaf de server naar het platform.
Het adres
POST https://panel.souver.nl/api/v1/aanmeldingen
Headers:
Authorization: Bearer sgn_…(de API-sleutel)Content-Type: application/jsonAccept: application/json
Een aanmelding is maximaal 32 KB.
Verplichte velden
| Veld | Uitleg |
|---|---|
privacy |
true: de aanvrager gaat akkoord met de verwerking van zijn gegevens |
company.name |
bedrijfsnaam |
contact.first_name |
voornaam van de contactpersoon |
contact.last_name |
achternaam van de contactpersoon |
contact.email |
e-mailadres van de contactpersoon |
Optionele velden
| Veld | Uitleg |
|---|---|
locale |
nl (standaard), en of de: de taal van de e-mails en foutmeldingen |
company.legal_form |
rechtsvorm, bijvoorbeeld B.V. |
company.kvk |
KvK-nummer, in Nederland 8 cijfers |
company.vat |
btw-nummer, bijvoorbeeld NL123456789B01 |
company.street, company.house_number, company.postal_code, company.city |
adres; postcode in Nederland als 1234 AB |
company.country |
landcode, bijvoorbeeld NL, BE of DE; standaard NL |
contact.role |
functie van de contactpersoon |
contact.phone |
mobiel nummer; een buitenlands nummer met + |
billing_email |
e-mailadres voor facturen, als dat anders is |
website |
website van de aanvrager |
expected |
verwachte aantallen: customers, domains, mailboxes, websites |
source |
hoe de aanvrager je vond |
note |
opmerking |
documents |
geaccepteerde documenten, zie het artikel over documenten |
meta.ip, meta.user_agent |
IP-adres en browser van de bezoeker (niet van je server) |
meta.honeypot |
de waarde van een verborgen veld; is het ingevuld, dan is het spam |
meta.form_ms |
tijd in milliseconden tussen het openen en versturen van het formulier; korter dan 3000 is spam |
Voorbeeld met curl
curl -s https://panel.souver.nl/api/v1/aanmeldingen \
-H "Authorization: Bearer $SIGNUP_KEY" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"locale": "nl",
"privacy": true,
"company": { "name": "Bakkerij De Test BV", "kvk": "12345678", "postal_code": "1234 AB", "city": "Testdorp", "country": "NL" },
"contact": { "first_name": "Els", "last_name": "Eigenaar", "email": "els@bakkerij.test", "phone": "06 12345678" },
"meta": { "ip": "203.0.113.7", "user_agent": "Mozilla/5.0", "honeypot": "", "form_ms": 48211 }
}'
Voorbeeld in PHP (Laravel)
$r = Http::withToken(config('services.signup.key'))->acceptJson()
->post('https://panel.souver.nl/api/v1/aanmeldingen', $gegevens + ['meta' => [
'ip' => request()->ip(),
'user_agent' => request()->userAgent(),
'honeypot' => request('website_url'),
'form_ms' => (int) request('form_ms'),
]]);
if ($r->status() === 422) {
return back()->withErrors($r->json('errors'))->withInput();
}
return view('bedankt', ['referentie' => $r->json('reference')]);
Goed om te weten
- Geef in
metahet IP-adres en de browser van de bezoeker mee. Dat is het bewijs bij geaccepteerde documenten. - Per e-mailadres kunnen er hooguit 3 aanmeldingen tegelijk openstaan.