Skip to content

Repository files navigation

Warning

The PTT-API-Solutions will be officially deprecated and shut down on August 31, 2026. It will be replaced with the new PTT API-Solutions V2. Please follow the migration instructions here.

Thank you for using PTT API-Solutions.

PTT API-Solutions

This is the End user manual for using the PTT API-Solutions.

1) Developing and Testing Environment (DTE-System)

Attention: The user and api-key shown below belong to a test account whose request range is limited to five communities only.

Test-ApiKey: sYp4kEAtyUnH67K1!gI1Nl-ikJsboXBKJqnW-V1fz2rJYOzQ4zg93Y8PU
Test-Requester:test@proptechtools.de

The following five communities are available in the DTE-system:

community keycity typecity namestatelatlng
072355007001communityAachRheinland-Pfalz49.789503,6.590633
083355001001cityAachBaden-Württemberg47.840882,8.859067
053340002002cityAachenNordrhein-Westfalen50.777180,6.093335
081365001088cityAalenBaden-Württemberg48.837336,10.094682
064390001001communityAarbergenHessen50.245978,8.078530

2) Live-System

When using your own Account-Credentials (also when using your own testaccount) you have to switch to the Live-System.
Changing from DTE-System to Live-System (with access to the complete database) is easy:


Obligatory parameters for the GET-Request for accessing every PTT API:

There are five different obligatory parameters which have to be included in every api-request. While apiKey,name and requester are for authentication purposes, latlng is used to autoanalyse the full address. In combination with objectkategorie the address values make up a unique order that connects all api-requests of different api-module and is displayed in the PTT-Webplattform module Auftragsmanagement. To remove uncertainty in the autoanalysis of the address, the addressparameters can be optionally overwritten by seperatlly requesting them.

PropertyExplanationMandatory?Default
apiKeyAuthentication purpose. apikey is unique per companyobligatory-
nameAuthentication purpose. name is unique per companyobligatory-
requesterAuthentication purpose. requester is unique per accountobligatory-
latlngOrdergeneration: Coordinates need to be submitted to generate unique order, that connects all api-requests from different modules with the same address.obligatoryFormat: XX.XXXXXX,XX.XXXXXX
objektkategorieOrdergeneration: Submit coordinates to generate unique order and connect api-requests of different modules with via addressparameters to itobligatoryList of parameters
adresszusatzOption to overwrite address autoanalysed by latlngoptionalautoanalysed if empty
strassennameOption to overwrite address autoanalysed by latlngoptionalautoanalysed if empty
hausnummerOption to overwrite address autoanalysed by latlngoptionalautoanalysed if empty
stadtOption to overwrite address autoanalysed by latlngoptionalautoanalysed if empty
plzOption to overwrite address autoanalysed by latlngoptionalautoanalysed if empty
bundeslandOption to overwrite address autoanalysed by latlngoptionalautoanalysed if empty
landOption to overwrite address autoanalysed by latlngoptionalautoanalysed if empty

Useful Documents:

Testing-environment

All PTT-APIs can be tested on https://api.proptechtools.de or Postman.

Changelog

Changelog of API-Updates

About

End user manual for using the ptt api solutions

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages