The Calcasa API is used to connect to Calcasa provided services. For more information, please visit Documentation or GitHub.
For more information, please visit https://www.calcasa.nl/contact.
PHP 8.1 and later.
To install the bindings via Composer, add the following to composer.json:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
}
],
"require": {
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
}
}Then run composer install
Download the files and include autoload.php:
<?php
require_once('/path/to/calcasa/api/vendor/autoload.php');Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth
$config = Calcasa\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Calcasa\Api\Api\AdressenApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$bagNummeraanduidingId = 56; // int | Een BAG Nummeraanduiding ID om een adres te specificeren.
try {
$result = $apiInstance->getAdres($bagNummeraanduidingId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AdressenApi->getAdres: ', $e->getMessage(), PHP_EOL;
}All URIs are relative to https://api.calcasa.nl/api/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdressenApi | getAdres | GET /adressen/{bagNummeraanduidingId} | Adres info op basis van BAG Nummeraanduiding Id. |
| AdressenApi | searchAdres | POST /adressen/zoeken | Zoek adresinformatie op basis van het opgegeven adres. |
| BestemmingsplannenApi | getBestemmingById | GET /bestemmingsplannen/{bagNummeraanduidingId} | Gegevens over de bestemmingsplannen op de locatie van een adres (BAG Nummeraanduiding ID). |
| BodemApi | getBodemById | GET /bodem/{bagNummeraanduidingId} | Gegevens over de bodemkwaliteit op de locatie van een adres (BAG Nummeraanduiding ID). |
| BuurtApi | getBuurt | GET /buurt/{buurtCode} | Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is. |
| CallbacksApi | addOrUpdateCallbackSubscription | POST /callbacks/inschrijvingen | Voeg een callback inschrijving toe (of werk bij) voor de huidige client voor een adres. |
| CallbacksApi | deleteNotificationSubscription | DELETE /callbacks/inschrijvingen/{bagNummeraanduidingId} | Verwijder de callback inschrijving voor deze client, dit adres en optioneel een geldverstrekker. |
| CallbacksApi | getNotificationSubscription | GET /callbacks/inschrijvingen/{bagNummeraanduidingId} | Haal de callback inschrijving op voor deze client, dit adres en eventueel opgegeven geldverstrekker. |
| CallbacksApi | getNotificationSubscriptions | GET /callbacks/inschrijvingen | Haal de callback inschrijvingen binnen voor deze client. |
| ConfiguratieApi | getCallbackAuthentication | GET /configuratie/callbacks/authentication | Haal de geconfigureerde callback authenticatie op voor de huidige client. |
| ConfiguratieApi | getCallbacks | GET /configuratie/callbacks | Haal de geconfigureerde callback URL's op voor de huidige client. |
| ConfiguratieApi | getMtlsCertificate | GET /configuratie/callbacks/mtls-certificate | Get the self-signed mTLS certificate. |
| ConfiguratieApi | getSignatureKeys | GET /configuratie/callbacks/signature-keys | Get the JWKS keys, deze kunnen worden gebruikt om de echtheid van webhooks te verifiëren. |
| ConfiguratieApi | postCallbackAuthentication | POST /configuratie/callbacks/authentication | Update de geconfigureerde callback authenticatie voor de huidige client. |
| ConfiguratieApi | updateCallbacks | POST /configuratie/callbacks | Configureer callback URL voor een specifieke API versie voor de huidige client. |
| FacturenApi | getFactuur | GET /facturen/{id} | Factuur op basis van een waardering Id. |
| FileSetsApi | confirmInboundFileSetById | PUT /file-sets/inbound/{inboundFileSetId} | Confirm an inbound file set after it has been fully uploaded. |
| FileSetsApi | createInboundFileSet | POST /file-sets/inbound | Create a new inbound file set. |
| FileSetsApi | deleteOutboundFileSetById | DELETE /file-sets/outbound/{outboundFileSetId} | Delete an outbound file set after it has been correctly received. If an outbound file set is not downloaded and deleted within 48 hours, it will expire and all its contents will be deleted automatically. |
| FileSetsApi | getInboundFileSetById | GET /file-sets/inbound/{inboundFileSetId} | Get a specific inbound file set by its ID. |
| FileSetsApi | getInboundFileSets | GET /file-sets/inbound | Get all inbound file sets. |
| FileSetsApi | getOutboundFileByIndex | GET /file-sets/outbound/{outboundFileSetId}/{fileIndex} | Get a specific outbound file content by its index within a file set. |
| FileSetsApi | getOutboundFileSetById | GET /file-sets/outbound/{outboundFileSetId} | Get a specific outbound file set by its ID. |
| FileSetsApi | getOutboundFileSets | GET /file-sets/outbound | Get all outbound file sets. |
| FileSetsApi | putFileChunk | PUT /file-sets/inbound/{inboundFileSetId}/{fileIndex} | Upload a specific file chunk for an inbound file set. |
| FotosApi | getFoto | GET /fotos/{id} | Foto op basis van een foto Id. |
| FunderingenApi | getFunderingById | GET /funderingen/{bagNummeraanduidingId} | Gegevens over de fundering op de locatie van een adres (BAG Nummeraanduiding ID). |
| GeldverstrekkersApi | getGeldverstrekkers | GET /geldverstrekkers/{productType} | Alle geldverstrekkers die te gebruiken zijn voor aanvragen. |
| RapportenApi | getRapport | GET /rapporten/{id} | Rapport op basis van waardering Id. |
| WaarderingenApi | checkProducten | POST /waarderingen/check | Controleert mogelijke producten. |
| WaarderingenApi | createWaardering | POST /waarderingen | Maak een waardering aan. |
| WaarderingenApi | getWaardering | GET /waarderingen/{id} | Waardering op basis van Id. |
| WaarderingenApi | getWaarderingByReportHash | GET /waarderingen/by-hash/{hash} | Waardering op basis van upper-case hex SHA-256 hash van een PDF rapport. Als er een collision is wordt de nieuwste waardering teruggegeven. |
| WaarderingenApi | getWaarderingOntwikkeling | GET /waarderingen/{id}/ontwikkeling | Waardering ontwikkeling op basis van waardering Id. |
| WaarderingenApi | patchWaarderingen | PATCH /waarderingen/{id} | Patcht een waardering. |
| WaarderingenApi | searchWaarderingen | POST /waarderingen/zoeken | Zoek waardering op basis van input parameters. |
- Aanvraagdoel
- Adres
- AdresInfo
- Bestemmingsdata
- BodemStatusType
- Bodemdata
- BusinessRulesCode
- BusinessRulesProblemDetails
- Callback
- CallbackAuthentication
- CallbackInschrijving
- CbsIndeling
- DeelWaarderingWebhookPayload
- Energielabel
- EnergielabelData
- ExpiredValuationProblemDetails
- Factuur
- FileError
- FileInfo
- FileSet
- FileWarning
- Foto
- FrontendDeeplinks
- FunderingDataBron
- FunderingHerstelType
- FunderingRisico
- FunderingRisicoLabel
- FunderingSoortBron
- FunderingTechnischHerstelType
- FunderingType
- FunderingTypering
- Funderingdata
- Funderingsrisico
- Gebiedsdata
- Geldverstrekker
- InboundFileSet
- InboundFileSetAlreadyConfirmedProblemDetails
- InboundFileSetAlreadyExistsProblemDetails
- InboundFileSetState
- InboundFileSetWebhookPayload
- InvalidArgumentProblemDetails
- JsonPatchDocument
- KlantwaardeType
- Kwartaal
- MTLSType
- Modeldata
- NotFoundProblemDetails
- Notitie
- Notities
- Objectdata
- Omgevingsdata
- OnderhoudStaat
- Operation
- OperationType
- Opnamedata
- OutboundFileSet
- OutboundFileSetState
- OutboundFileSetWebhookPayload
- PermissionsDeniedProblemDetails
- ProblemDetails
- ProductCheck
- ProductCheckItem
- ProductCheckParameters
- ProductType
- Rapport
- Referentieobject
- ResourceExhaustedProblemDetails
- Taxatiedata
- Taxatiestatus
- UnauthorizedProblemDetails
- ValidationProblemDetails
- VerkoopBijzonderheden
- VersionNames
- VorigeVerkoop
- Waardering
- WaarderingInputParameters
- WaarderingOntwikkeling
- WaarderingOntwikkelingKwartaal
- WaarderingStatus
- WaarderingWebhookPayload
- WaarderingZoekParameters
- WebhookPayload
- WoningType
Authentication schemes defined for the API:
- Type:
OAuth - Flow:
application - Authorization URL: ``
- Scopes:
- api:adressen:read:
- api:bestemmingsplannen:read:
- api:bodem:read:
- api:buurt:read:
- api:callback:read:
- api:callback:write:
- api:configuratie:read:
- api:configuratie:write:
- api:facturen:read:
- api:fotos:read:
- api:funderingen:read:
- api:geldverstrekkers:read:
- api:rapporten:read:
- api:waarderingen:read:
- api:waarderingen:patch:
- api:waarderingen:ontwikkeling:
- api:waarderingen:create:
- api:file-set:inbound:write:
- api:file-set:inbound:read:
- api:file-set:outbound:read:
- api:file-set:outbound:write:
To run the tests, use:
composer install
vendor/bin/phpunitThis PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.6.0-beta3- Generator version:
7.16.0
- Generator version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen