Setup Enquire a Bearer Token from Api Support # Authentication Use API calls with an Authorization: Bearer TOKEN header # Webhooks The application supports sending secured notification events to registered endpoints. The events one may receive are sent as POST https://your.webhook.url/path/somewhere Authorization: Bearer TOKEN { \"connectionId\": 0, \"entityType\": \"properties|contacts|invoices|etc.\", \"entityId\": 0, \"eventType\": \"CREATE|UPDATE|DELETE\" } <style> code { display: block; } </style>
This Python package is automatically generated by the Swagger Codegen project:
- API version: 2.201.52181d67
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit https://impower.de
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import impower_client Install via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import impower_clientPlease follow the installation procedure and then run the following:
from __future__ import print_function
import time
import impower_client
from impower_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: API Key
configuration = impower_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = impower_client.ContactAPIApi(impower_client.ApiClient(configuration))
contact_id = 789 # int | Unique identifier of a contact
try:
# Get a contact by the given id
api_response = api_instance.get_contact_by_id_using_get(contact_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContactAPIApi->get_contact_by_id_using_get: %s\n" % e)
# Configure API key authorization: API Key
configuration = impower_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = impower_client.ContactAPIApi(impower_client.ApiClient(configuration))
contact_ids = [56] # list[int] | List of contact ids to filter contacts by. (optional)
email = 'email_example' # str | Email address of the contact. (optional)
name = 'name_example' # str | Any name of the contact. Might be first name, last name or company name. (optional)
order = 'order_example' # str | Sorting direction. Possible values: ASC, DESC (optional)
page = 56 # int | Page number to be returned (optional)
size = 56 # int | Number of items to be returned in single page (optional)
sort = 'sort_example' # str | Sorting parameter (optional)
try:
# Get contacts by the given filter parameters
api_response = api_instance.get_contacts_by_filter_using_get(contact_ids=contact_ids, email=email, name=name, order=order, page=page, size=size, sort=sort)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContactAPIApi->get_contacts_by_filter_using_get: %s\n" % e)All URIs are relative to https://api.app.impower.de/
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ContactAPIApi | get_contact_by_id_using_get | GET /v2/contacts/{contactId} | Get a contact by the given id |
| ContactAPIApi | get_contacts_by_filter_using_get | GET /v2/contacts | Get contacts by the given filter parameters |
| ContractAPIApi | get_contract_by_id_using_get | GET /v2/contracts/{contractId} | Get a contract by the given id |
| ContractAPIApi | get_contracts_by_filter_using_get | GET /v2/contracts | Get contracts by the given filter parameters |
| DocumentAPIApi | create_document_by_upload_using_post | POST /v2/documents/upload | Create a new document based on given the file |
| DocumentAPIApi | delete_document_using_delete | DELETE /v2/documents/{documentId} | Delete an existing document based on the given id |
| DocumentAPIApi | download_documents_by_filter_using_get | GET /v2/documents/download-zip | Download multiple documents by given filter conditions |
| DocumentAPIApi | download_using_get | GET /v2/documents/{documentId}/download | Download a single document by given id |
| DocumentAPIApi | get_documents_by_filter_using_get | GET /v2/documents | Get documents by the given filter parameters |
| DocumentAPIApi | update_documents_using_put | PUT /v2/documents | Update an existing document based on the given request body |
| DocumentTagAPIApi | create_document_tag_using_post | POST /v2/document-tags | 7929Create a new document tag |
| DocumentTagAPIApi | delete_document_tag_using_delete | DELETE /v2/document-tags/{tagId} | Delete an existing document tag based on the given id |
| DocumentTagAPIApi | get_document_tags_using_get | GET /v2/document-tags | Get document tags |
| DocumentTagAPIApi | update_document_tag_using_put | PUT /v2/document-tags/{tagId} | Update an existing document tag based on the given id |
| ErrorCodeAPIApi | error_code_using_get | GET /api/v1/error-codes/{value} | Get details of a specific error code |
| ErrorCodeAPIApi | error_codes_using_get | GET /api/v1/error-codes | Get all predefined error code values |
| InvoiceAPIApi | get_invoice_by_id_using_get | GET /v2/invoices/{invoiceId} | Get a invoice by the given id |
| InvoiceAPIApi | get_invoices_by_filter_using_get | GET /v2/invoices | Get invoices by the given filter parameters |
| InvoiceAPIApi | update_invoice_using_put | PUT /v2/invoices/{invoiceId} | Update an invoice based on provided fields |
| InvoiceAPIApi | upload_invoice_using_post | POST /v2/invoices/upload | Upload invoice PDF document |
| InvoiceItemAPIApi | update_invoice_item_using_put | PUT /v2/invoice-items/{invoiceItemId} | Update booking text of the given invoice booking item |
| PropertyAPIApi | get_properties_by_filter_using_get | GET /v2/properties | Get properties by the given filter parameters |
| PropertyAPIApi | get_property_by_id_using_get | GET /v2/properties/{propertyId} | Get a property by the given id |
| UnitAPIApi | get_unit_by_id_using_get | GET /v2/units/{unitId} | Get a unit by the given id |
| UnitAPIApi | get_units_by_filter_using_get | GET /v2/units | Get all units by given filter parameters |
- ContactDetailsDto
- ContactDto
- ContactSimpleDto
- ContractDto
- DocumentDto
- DocumentTagCreateDto
- DocumentTagDto
- DocumentTagSimpleDto
- DocumentTagUpdateDto
- DocumentUpdateDto
- DocumentsUploadBody
- ErrorCodeDetailsDto
- InvoiceDto
- InvoiceItemDto
- InvoiceItemUpdateDto
- InvoiceUpdateDto
- InvoicesUploadBody
- PageOfContactDto
- PageOfContractDto
- PageOfDocumentDto
- PageOfInvoiceDto
- PageOfPropertyDto
- PageOfUnitDto
- Pageable
- PropertyDto
- Sort
- UnitDto
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header