Download the PHP package calcasa/api without Composer
On this page you can find all versions of the php package calcasa/api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package api
Short Description API client for the Calcasa Public API.
License Apache-2.0
Homepage https://github.com/calcasa/api-php
Informations about the package api
calcasa/api
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
:
Then run composer install
Manual Installation
Download the files and include autoload.php
:
Getting Started
Please follow the installation procedure and then run the following:
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 | getCallbacks | GET /configuratie/callbacks | Haal de geconfigureerde callback URL's op 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 | createWaardering | POST /waarderingen | Creërt een waardering. |
WaarderingenApi | getWaardering | GET /waarderingen/{id} | Waardering op basis van Id. |
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
- Aanvraagdoel
- Adres
- AdresInfo
- Bestemmingsdata
- BodemStatusType
- Bodemdata
- BusinessRulesCode
- BusinessRulesProblemDetails
- Callback
- CallbackInschrijving
- CbsIndeling
- DeelWaarderingWebhookPayload
- Energielabel
- EnergielabelData
- Factuur
- Foto
- FunderingDataBron
- FunderingHerstelType
- FunderingRisico
- FunderingRisicoLabel
- FunderingSoortBron
- FunderingType
- FunderingTypering
- Funderingdata
- Gebiedsdata
- Geldverstrekker
- InvalidArgumentProblemDetails
- JsonPatchDocument
- KlantwaardeType
- Kwartaal
- Modeldata
- NotFoundProblemDetails
- Notitie
- Notities
- Objectdata
- Omgevingsdata
- Operation
- OperationType
- PermissionsDeniedProblemDetails
- ProblemDetails
- ProductType
- Rapport
- Referentieobject
- ResourceExhaustedProblemDetails
- Taxatiedata
- Taxatiestatus
- UnauthorizedProblemDetails
- ValidationProblemDetails
- VerkoopBijzonderheden
- VersionNames
- VorigeVerkoop
- Waardering
- WaarderingInputParameters
- WaarderingOntwikkeling
- WaarderingOntwikkelingKwartaal
- WaarderingStatus
- WaarderingWebhookPayload
- WaarderingZoekParameters
- WebhookPayload
- WoningType
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:
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.4.0-rc1
- Generator version:
7.13.0
- Generator version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen
All versions of api with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^2.0