Paden

Elk pad van API versie 1, met het account dat het mag aanroepen.

Vaak KLIC-meldingen nodig? Bekijk de voordelige creditbundels

Adres: https://klicbot.nl/api/v1

Specificatie: GET /api/v1/openapi.json (alleen deze paden, zonder sleutel).

Elk verzoek stuurt X-API-Key, behalve de specificatie en de openbare formulieren op dezelfde prefix.

PRO

Methode Pad Recht Wat je krijgt
POST /jobs lezen, schrijven bij submit Prijs. Zonder submit gaat er niets naar het Kadaster. Body: geometry, klic_type (ORIENT of GRAAF), optioneel crs, reference, client_ref, address, webhook_url, start_date, voorstel, address_hold, quote_scope, is_test, force_new, file
POST /jobs/from-file lezen Zelfde prijs vanuit DXF, DWG, GeoJSON, KML, KMZ, GML, GPKG, een Shapefile-zip of CSV
POST /jobs/{job_id}/revise lezen Zelfde job, nieuwe prijs. De vorige quote_hash geldt niet meer
POST /jobs/{job_id}/checkout schrijven Betaalpagina. HTTP 200. status is payment_pending. Geen bedrag in de body
POST /jobs/{job_id}/test-pay schrijven Alleen een testjob. Simuleert betaling. HTTP 200, daarna ready
GET /jobs lezen Jobs van dit bedrijf
GET /jobs/{job_id} lezen Status, next_action, quote_hash, payment_url. Bij ready ook dossier_url en dossier_label
GET /jobs/{job_id}/geojson lezen Levering in RD New. Alleen na betaling
GET /jobs/{job_id}/export?format=shp lezen Shapefile-zip
GET /jobs/{job_id}/export?format=geojson lezen GeoJSON
GET /jobs/{job_id}/export?format=gpkg lezen GeoPackage
GET /maps/{hash}.png geen Kaart van een prijs. De hash komt uit de prijs

submit=true op POST /jobs is voor PRO HTTP 403, code FORBIDDEN. Er is niets ingediend.

KLICBOT API

Deze paden blijven dicht voor PRO (HTTP 403, het woord enterprise staat in de fout):

Methode Pad Wat het doet
POST /jobs met submit=true Direct indienen, zonder betaalpagina. HTTP 202 als de factuur klaarstaat
POST /jobs/{job_id}/submit Hetzelfde
GET /requests Dossiers, blad voor blad
GET /request/{order_id} Eén KLIC-melding
GET /request/{order_id}/geojson Levering van die melding
POST /keys Nieuwe sleutel. Vereist admin op de aanroepende sleutel
GET /keys Sleutels van dit bedrijf
DELETE /keys/{key_id} Sleutel intrekken

De maandfactuur en een eigen Kadaster-relatienummer horen hier. PRO betaalt via checkout.

Foutcodes

De vorm is meestal:

{"detail": {"error_code": "FORBIDDEN", "detail": "Er is niets ingediend."}}
HTTP Code Wanneer
400 GEOMETRY_INVALID De polygoon klopt niet
400 START_DATE_REQUIRED Graafmelding indienen zonder start_date
400 WEBHOOK_URL_INVALID webhook_url is geen toegestane https-URL
400 FORMAT_INVALID format is niet shp, geojson of gpkg
400 CHECKOUT_REJECTED Onder meer een verouderde quote
400 FILE_INVALID Het bestand is niet te lezen
402 NOT_PAID PRO vraagt levering van een job die nog niet betaald is
402 BILLING_REQUIRED Direct indienen zonder factuurregeling
403 FORBIDDEN PRO probeert in te dienen, of de sleutel mist een recht
403 TEST_MODE Testmodus probeert echt in te dienen of een live job te "betalen"
403 Geen header: tekst CSRF token missing or invalid. Slechte sleutel: Invalid API Key
404 JOB_NOT_FOUND Onbekende job, of een job van een ander bedrijf
409 NOT_READY Betaald, maar de levering is er nog niet

Een graafmelding die je echt indient vereist start_date. Een oriëntatieverzoek niet.

Maatwerk: contact@klicbot.nl.