README

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.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

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

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/calcasa/api/vendor/autoload.php');

Getting Started

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;
}

API Endpoints

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 adres info op basis van het gegeven 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.
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	Creërt een waardering.
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.

Models

Authorization

Authentication schemes defined for the API:

oauth

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:

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

info@calcasa.nl

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.5.5
- Generator version: 7.16.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

calcasa/api

包简介

关键字：

README 文档