Authenticatie, invoer en resultaat

Authenticatie, invoer en reactie Beoordeel het volledige potentieel van de Satelliet Dakscan API door de belangrijkste parameters en het antwoord te begrijpen.

POST https://api.altum.ai/satellite-roof-scan

Het endpoint stelt u in staat om te communiceren met de Satelliet Dakscan API door specifieke queries te verzenden, zoals postcodes, om gedetailleerde vastgoedgegevens op te halen. Het volledige endpoint vindt u hierboven.

Queryparameters

Parameter	Type	Beschrijving
bagid	string	Het unieke BAG-identificatienummer van het gebouw.

Headers

Header	Type	Beschrijving
Content-Type	string	application/json
x-api-key*	string	Unieke API-sleutel van Altum. Verkrijgbaar via Mopsus (https://mopsus.altum.ai)

Response Bij een succesvolle POST-aanvraag retourneert de API een 200 OK-status met een JSON-object dat de resultaten bevat.

Voorbeeld van volledige output

Veld	Type	Beschrijving
bagid	string	Het BAG-ID van het opgevraagde pand.
num_panels_detected	integer	Het totale aantal gedetecteerde zonnepanelen (of andere objecten).
detections	array	Een array van JSON-objecten, waarbij elk object een gedetecteerd zonnepaneel beschrijft, inclusief label, betrouwbaarheids-score en bounding box-coördinaten.
annotated_image_url	string	Een openbare URL naar de afbeelding waarop de gedetecteerde zonnepanelen zijn weergegeven.

Request body Een geldig POST-verzoek ziet er bijvoorbeeld zo uit:

{"bagid": "0363010000688380"}

Output Bij een succesvolle POST-aanvraag retourneert de API een 200 OK-status met een JSON-object dat de resultaten bevat.

Voorbeeld van volledige output

{
  "bagid": "0363010000688380",
  "num_panels_detected": 15,
  "detections": [
    {
      "label": "solar-panel",
      "confidence": 0.91,
      "bbox": {
        "x1": 0,
        "y1": 1054,
        "x2": 406,
        "y2": 1293,
        "width": 406,
        "height": 239
      }
    }
    ... (meer detecties)
  ],
  "annotated_image_url": "https://altum-gis.s3.eu-west-1.amazonaws.com/solar_panels/0363010000688380_79dc9a90.png"
}

200: OK Standard response

{
  "bagid": "0363010000688380",
  "num_panels_detected": 15,
  "detections": [
    {
      "label": "solar-panel",
      "confidence": 0.91,
      "bbox": {
        "x1": 0,
        "y1": 1054,
        "x2": 406,
        "y2": 1293,
        "width": 406,
        "height": 239
      }
    },
    ... (more detections)
  ],
  "annotated_image_url": "https://altum-gis.s3.eu-west-1.amazonaws.com/solar_panels/0363010000688380_79dc9a90.png"
}

400: Bad Request Unsuccessful response

{
	The request was invalid.
}

404 Not Found

Failed to scrape image for BAG ID: {bagid}. 
This might mean the BAG ID was not found in the database or there was an issue with PDOK API.

500: Internal Server Error Service is not available and/or down

{
	"message": "An unexpected server error occurred."
}