ZDS-Client - Generieke client voor GEMMA-zaken componenten

De ZDS-Client is een (voorlopig) interne client die op basis van OAS 3.0 specificaties met GEMMA-zaken componenten communiceert.

Contents

• 1   Features
• 2   Installatie
  • 2.1   Benodigdheden
  • 2.2   Installeren
• 3   Gebruik
  • 3.1   Initialiseren (statische configuratie)
  • 3.2   Initialiseren (ad-hoc configuratie)
  • 3.3   Resources manipuleren
  • 3.4   Usage with NLX

1   Features

• Ophalen van OAS 3.0 spec & caching
• Aanmaken van resources volgens specificatie
• Generieke opzet, maar specifiek gebruik in de zaakgericht-werken services
• Introspectie in het OAS schema: lees op basis van een resource URL uit wat er precies hoort achter deze URL te zitten.
• ZDS autorisatiemodel via JWT out-of-the-box ondersteund.

2   Installatie

2.1   Benodigdheden

• Python 3.6 of hoger
• setuptools 30.3.0 of hoger

2.2   Installeren

pip install gemma-zds-client

3   Gebruik

3.1   Initialiseren (statische configuratie)

De client moet geinitialiseerd worden met de locatie van de componenten. Dit kan eenmalig of just-in-time wanneer je de client nodig hebt:

from zds_client import Client

Client.load_config('/pad/naar/config.yml')

De makkelijkste manier is configuratie via een yaml bestand, in het formaat:

---

zrc:
  scheme: http
  host: localhost
  port: 8000
  auth:
    client_id: my-zrc-client-id
    secret: my-zrc-client-secret

drc:
  scheme: http
  host: localhost
  port: 8001

ztc:
  scheme: http
  host: localhost
  port: 8002

orc:
  scheme: http
  host: localhost
  port: 8003

De key is de naam van de component.

Je kan echter ook de configuratie zonder yaml bestand doen, en volledig gebruik maken van Python dictonaries, bijvoorbeeld:

from zds_client import Client

ZRC = {
    'scheme': 'http',
    'host': 'localhost',
    'port': 8000,
}

DRC = {
    'scheme': 'http',
    'host': 'localhost',
    'port': 8001,
}

Client.load_config(**{
    'zrc': ZRC,
    'drc': DRC,
    ...
})

3.2   Initialiseren (ad-hoc configuratie)

Je kan ook een client instance verkrijgen op basis van een specifieke resource URL.

from zds_client import Client

client = Client.from_url('https://api.nl/v1/resource/123')

Indien autorisatie hierop nodig is, kan je deze zelf assignen:

from zds_client import ClientAuth

client.auth = ClientAuth(
    client_id='my-client-id',
    secret='my-client-secret',
)

3.3   Resources manipuleren

Per component kan je vervolgens een client resources laten opvragen of manipuleren:

zrc_client = Client('zrc')  # gebruik alias uit configuratie

# oplijsten
zaken = zrc_client.list('zaak')

# opvragen
zaak = zrc_client.retrieve('zaak', uuid='<uuid>')

# opvragen met URL
zaak = zrc_client.retrieve('zaak', url='<zaak_url>')

# aanmaken
zaak = zrc_client.create('zaak', {
    'bronorganisatie': '000000000',
    'zaaktype': 'http://localhost:8002/api/v1/zaaktypen/<uuid>'
})

Operation suffixes

De operation_id van de OAS-operations staan centraal - op basis hiervan wordt de URL + HTTP method opgehaald die nodig is voor de call. Je kan deze suffixes overriden in client subclasses:

class MyClient(Client):
    operation_suffix_mapping = {
        "list": "List",
        "retrieve": "Retrieve",
        "create": "Create",
        "update": "Update",
        "partial_update": "PartialUpdate",
        "delete": "Delete",
    }

3.4   Usage with NLX

When you're using NLX outways, the URLs of resources change because of this. Services expoxed via NLX inways don't understand local outway URLs, so these need to get rewritten.

In Django projects, you can use zgw-consumers, which has built-in support for NLX and the required URL rewrites. This library is a dependency of zgw-consumers.