Skip to main content

API Client library to communicate with the Open Klant service.

Project description

A Python client library for interacting with the Open Klant API.

Installation

pip install open-klant-client

Usage

Initialize the client with your API endpoint and token:

from openklant_client import OpenKlantClient

client = OpenKlantClient(
    base_url="https://example.com/klantinteracties/api/v1",
    token="your_api_token"
)

List resources

# List all partijen
partijen = client.partij.list()

# List klantcontacten with filters
contacten = client.klant_contact.list(params={"onderwerp": "vraag"})

# Auto-paginate through all results (max_requests=None means paginate until all rows are retrieved)
for partij in client.partij.list_iter(max_requests=10):
    print(partij)

Get a specific resource

# Get a partij by UUID
partij = client.partij.get(uuid="123e4567-e89b-12d3-a456-426614174000")

Create a resource

# Create a new actor
actor = client.actor.create(
    data={
        "naam": "John Doe",
        "soortActor": "medewerker",
        "indicatieActief": True,
        "actoridentificator": {
            "objectId": "123456",
            "codeObjecttype": "employee",
            "codeRegister": "hr",
            "codeSoortObjectId": "id",
        },
    }
)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

open_klant_client-0.2.0.tar.gz (27.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

open_klant_client-0.2.0-py3-none-any.whl (31.2 kB view details)

Uploaded Python 3

File details

Details for the file open_klant_client-0.2.0.tar.gz.

File metadata

  • Download URL: open_klant_client-0.2.0.tar.gz
  • Upload date:
  • Size: 27.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for open_klant_client-0.2.0.tar.gz
Algorithm Hash digest
SHA256 6fb820300b73e23445ddc5489ef142c6bd1679d965e7f5173b0a77f48e53188a
MD5 fe2978d51517819216e77381bebe2ae9
BLAKE2b-256 2577c4c11373535ede85bf162e23e9433ba8f61b1f8312130c10534de0fdb9b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_klant_client-0.2.0.tar.gz:

Publisher: ci.yml on maykinmedia/open-klant-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file open_klant_client-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for open_klant_client-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6c58b4d4b3aa578b7b5426d7011d1c1237c5fe99375a16e5d3a30a4b98c05b20
MD5 9976878f1a64edca13df8b46d054fe1b
BLAKE2b-256 4749422b8cd96d99c5f4e2559408f5e94b0f14182ba1569f84972a1d4a5c4bbb

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_klant_client-0.2.0-py3-none-any.whl:

Publisher: ci.yml on maykinmedia/open-klant-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page