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}	Haal adresinformatie op.
AdressenApi	searchAdres	POST /adressen/zoeken	Zoek adresinformatie.
BestemmingsplannenApi	getBestemmingById	GET /bestemmingsplannen/{bagNummeraanduidingId}	Haal bestemmingsplannen op.
BodemApi	getBodemById	GET /bodem/{bagNummeraanduidingId}	Haal bodemkwaliteitsgegevens op.
BuurtApi	getBuurt	GET /buurt/{buurtCode}	Haal buurtgegevens op.
CallbacksApi	addOrUpdateCallbackSubscription	POST /callbacks/inschrijvingen	Maak of werk een callbackinschrijving bij.
CallbacksApi	deleteNotificationSubscription	DELETE /callbacks/inschrijvingen/{bagNummeraanduidingId}	Verwijder een callbackinschrijving.
CallbacksApi	getNotificationSubscription	GET /callbacks/inschrijvingen/{bagNummeraanduidingId}	Haal een callbackinschrijving op.
CallbacksApi	getNotificationSubscriptions	GET /callbacks/inschrijvingen	Haal callbackinschrijvingen op.
ConfiguratieApi	getCallbackAuthentication	GET /configuratie/callbacks/authentication	Haal callbackauthenticatie op.
ConfiguratieApi	getCallbacks	GET /configuratie/callbacks	Haal callback-URL's op.
ConfiguratieApi	getMtlsCertificate	GET /configuratie/callbacks/mtls-certificate	Haal het mTLS-certificaat op.
ConfiguratieApi	getSignatureKeys	GET /configuratie/callbacks/signature-keys	Haal JWKS-sleutels op.
ConfiguratieApi	postCallbackAuthentication	POST /configuratie/callbacks/authentication	Werk callbackauthenticatie bij.
ConfiguratieApi	updateCallbacks	POST /configuratie/callbacks	Configureer een callback-URL.
FacturenApi	getFactuur	GET /facturen/{id}	Haal een factuur op.
FileSetsApi	confirmInboundFileSetById	POST /file-sets/inbound/{inboundFileSetId}	Confirm an inbound file set.
FileSetsApi	createInboundFileSet	POST /file-sets/inbound	Create an inbound file set.
FileSetsApi	deleteOutboundFileSetById	DELETE /file-sets/outbound/{outboundFileSetId}	Delete an outbound file set.
FileSetsApi	getFileSetLimits	GET /file-sets/limits	Get file set limits.
FileSetsApi	getInboundFileSetById	GET /file-sets/inbound/{inboundFileSetId}	Get an inbound file set.
FileSetsApi	getInboundFileSets	GET /file-sets/inbound	List inbound file sets.
FileSetsApi	getOutboundFileByIndex	GET /file-sets/outbound/{outboundFileSetId}/{fileIndex}	Download outbound file content.
FileSetsApi	getOutboundFileSetById	GET /file-sets/outbound/{outboundFileSetId}	Get an outbound file set.
FileSetsApi	getOutboundFileSets	GET /file-sets/outbound	List outbound file sets.
FileSetsApi	putFileChunk	PUT /file-sets/inbound/{inboundFileSetId}/{fileIndex}/{chunkIndex}	Upload an inbound file chunk.
FotosApi	getFoto	GET /fotos/{id}	Haal een foto op.
FunderingenApi	getFunderingById	GET /funderingen/{bagNummeraanduidingId}	Haal funderingsgegevens op.
GeldverstrekkersApi	getGeldverstrekkers	GET /geldverstrekkers/{productType}	Haal geldverstrekkers op.
PlanningApi	assignOpnemer	POST /planning/opnames/{opnameId}	Assign an opnemer.
PlanningApi	deletePlanningForOpname	DELETE /planning/opnames/{opnameId}	Delete an opname planning.
PlanningApi	getOpnames	GET /planning/opnames	List opnames.
PlanningApi	getOpnemers	GET /planning/opnemers	List opnemers.
RapportenApi	getRapport	GET /rapporten/{id}	Haal een rapport op.
WaarderingenApi	checkProducten	POST /waarderingen/check	Controleer mogelijke producten.
WaarderingenApi	createWaardering	POST /waarderingen	Maak een waardering.
WaarderingenApi	getWaardering	GET /waarderingen/{id}	Haal een waardering op.
WaarderingenApi	getWaarderingByReportHash	GET /waarderingen/by-hash/{hash}	Zoek op rapport-hash.
WaarderingenApi	getWaarderingOntwikkeling	GET /waarderingen/{id}/ontwikkeling	Haal waarderingsontwikkeling op.
WaarderingenApi	patchWaarderingen	PATCH /waarderingen/{id}	Werk een waardering bij.
WaarderingenApi	searchWaarderingen	POST /waarderingen/zoeken	Zoek waarderingen.

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:file-set:inbound:read:
- api:file-set:inbound:write:
- api:file-set:outbound:read:
- api:file-set:outbound:write:
- 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:planning:read:
- api:planning:write:

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.7.1
- Package version: 1.7.1
- Generator version: 7.23.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

calcasa / api

Package info

Security

Statistics