# 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.

<mark style="color:green;">`POST`</mark> `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                                                                                                                                       |
| --------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `postcode`      | `string`  | postcode in zeskarakterformaat, bijvoorbeeld 1234AB                                                                                                |
| `huisnummer`    | `string`  | huisnummer van het object, bijvoorbeeld 1                                                                                                          |
| `huisletter`    | `string`  | toevoeging aan het huisnummer, bijvoorbeeld A                                                                                                      |
| `roof_geometry` | `boolean` | Toont de polygoonvorm van het geselecteerde dak; indien false wordt de geometrie overgeslagen en wordt alleen beeldgebaseerde detectie uitgevoerd. |
| `image_source`  | `string`  | Geeft aan waar de beelddata vandaan komt (auto, **pdok**, **esri**, **google\_maps**).                                                             |

{% hint style="info" %}
**Opmerking:**

* De huisletter is een **optioneel veld**; je kunt dit leeg laten (""). Anders zijn alle velden verplicht.
* Sommige dakgeometrieën zijn niet altijd beschikbaar.
* Google Maps-services zijn tijdelijk uitgeschakeld.
* Je kunt de afbeeldingsbron wisselen tussen **pdok**, **esri** of **auto** (standaard).
  {% endhint %}

**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                                                                                                                                                  |
| --------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `postcode`            | `string`  | postcode in zeskarakterformaat, bijvoorbeeld 1234AB                                                                                                           |
| `huisnummer`          | `string`  | huisnummer van het object, bijvoorbeeld 1                                                                                                                     |
| `huisletter`          | `string`  | toevoeging aan het huisnummer, bijvoorbeeld A                                                                                                                 |
| `imagery_source`      | `string`  | Bron van de gebruikte luchtfoto.                                                                                                                              |
| `annotated_image_url` | `string`  | Een openbare URL naar de afbeelding waarop de gedetecteerde zonnepanelen zijn weergegeven.                                                                    |
| `imagery_date`        | `date`    | Datum waarop de luchtfoto is gemaakt.                                                                                                                         |
| `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. |

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

```json
{
  "postcode": "4624AD",
  "housenumber": "4",
	"huisletter": "",
  "roof_geometry": true,
  "image_source": "auto" 
}
```

**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**

```json
{
	"postcode": "4624AD",
	"housenumber": "4",
	"huisletter": "",
	"houseaddress": "4624AD-4-",
	"imagery_source": "PDOK Aerial RGB (Open), Current Ortho 25cm RGB",
	"annotated_image_url": "https://altum-gis.s3.eu-west-1.amazonaws.com/solar_panels/4624AD-4-_6bec97ef.png",
	"imagery_date": "2025",
	"num_panels_detected": 8,
	"detections": [
		{
			"label": "solar",
			"confidence": 0.69,
			"bbox": {
				"x1": 342,
				"y1": 656,
				"x2": 525,
				"y2": 687,
				"width": 183,
				"height": 31
			}
    },
    ... (more detections)
  ]
}
```

<figure><img src="/files/wB9DKbJnMInpiBWQY0YW" alt="" width="375"><figcaption></figcaption></figure>

{% tabs %}
{% tab title="200: OK Standard response" %}

```
{
	"postcode": "4624AD",
	"housenumber": "4",
	"huisletter": "",
	"houseaddress": "4624AD-4-",
	"imagery_source": "PDOK Aerial RGB (Open), Current Ortho 25cm RGB",
	"annotated_image_url": "https://altum-gis.s3.eu-west-1.amazonaws.com/solar_panels/4624AD-4-_6bec97ef.png",
	"imagery_date": "2025",
	"num_panels_detected": 8,
	"detections": [
		{
			"label": "solar",
			"confidence": 0.69,
			"bbox": {
				"x1": 342,
				"y1": 656,
				"x2": 525,
				"y2": 687,
				"width": 183,
				"height": 31
			}
    },
    ... (more detections)
  ]
}
```

{% endtab %}

{% tab title="400: Bad Request Unsuccessful response" %}

```
{
	The request was invalid.
}
```

{% endtab %}

{% tab title="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.


```

{% endtab %}

{% tab title="500: Internal Server Error Service is not available and/or down" %}

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

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.altum.ai/verduurzamen/satelliet-dakscan-api/authentication-input-and-response.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.