REST API

Coplr Data API

Haal adressen, meters en verbruiksdata op uit je eigen website of applicatie. Vraag een API key aan in je portal.

Authenticatie

Stuur de API key mee als Authorization: Bearer <key> of als X-API-Key header.

Authorization: Bearer clp_live_<jouw_key>

GET/api/public/v1/address

Adresgegevens, BAG-details en energielabel op basis van postcode + huisnummer.

curl "https://coplr.nl/api/public/v1/address?postcode=3621HK&huisnr=130" \
  -H "Authorization: Bearer clp_live_..."

GET/api/public/v1/meters

EAN-nummers voor elektriciteit en gas op het opgegeven adres.

curl "https://coplr.nl/api/public/v1/meters?postcode=3621HK&huisnr=130" \
  -H "Authorization: Bearer clp_live_..."

POST/api/public/v1/intake

Maak een nieuwe intake aan. Deze verschijnt in /admin en /klantportaal.

curl -X POST "https://coplr.nl/api/public/v1/intake" \
  -H "Authorization: Bearer clp_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "postalCode": "3621HK",
    "houseNumber": "130",
    "name": "Piet Jansen",
    "email": "piet@example.com"
  }'

GET/api/public/v1/intake/{id}

Status van een intake, inclusief de uitgelezen meterfoto's.

curl "https://coplr.nl/api/public/v1/intake/<intake-id>" \
  -H "Authorization: Bearer clp_live_..."

POST/api/public/v1/meter-photo

Upload een foto van de slimme meter. De foto wordt privé opgeslagen en direct met OCR uitgelezen: meternummer, EAN, betrouwbaarheid en het kader waar het nummer op de foto staat. Stuur JSON met een base64 data-URL, of multipart/form-data met een veld 'photo'. Max 8 MB, jpeg/png/webp/heic.

curl -X POST "https://coplr.nl/api/public/v1/meter-photo" \
  -H "Authorization: Bearer clp_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "meterKind": "electricity",
    "intakeId": "<intake-id>",
    "imageBase64": "data:image/jpeg;base64,/9j/4AAQ..."
  }'

# of als bestand-upload:
curl -X POST "https://coplr.nl/api/public/v1/meter-photo" \
  -H "Authorization: Bearer clp_live_..." \
  -F "photo=@meter.jpg" -F "meterKind=electricity"

# antwoord
{ "data": { "photoId": "...", "meterNumber": "E0052005324847819",
            "ean": "871687400006992856", "confidence": "hoog",
            "box": { "x": 0.21, "y": 0.62, "w": 0.4, "h": 0.08 } }, "error": null }

POST/api/public/v1/consent

(Optioneel) Registreer een ondertekende toestemmingsverklaring voor slimme meter uitlezing.

curl -X POST "https://coplr.nl/api/public/v1/consent" \
  -H "Authorization: Bearer clp_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "ean": "123456789012345678",
    "meterKind": "electricity",
    "name": "Piet Jansen",
    "email": "piet@example.com",
    "postalCode": "3621HK",
    "houseNumber": "130",
    "organizationName": "Nova Clima",
    "organizationAddress": "Hoofdstraat 1",
    "organizationPostalCode": "1234 AB",
    "organizationCity": "Amsterdam",
    "signerName": "Piet Jansen",
    "signerEmail": "piet@example.com"
  }'

GET/api/public/v1/usage

Verbruiksdata van een bestaande P4 feed.

curl "https://coplr.nl/api/public/v1/usage?feedId=...&channel=...&from=2025-01-01&to=2025-01-31" \
  -H "Authorization: Bearer clp_live_..."

Rate limits & fouten

Standaard 60 verzoeken per minuut en 1.000 per dag per key.
401 = ongeldige of ontbrekende key.
403 = key niet actief of domein niet toegestaan.
429 = rate limit overschreden.