Models

The models documented here are part of the public API.

Concrete

Service

The Service model is aimed at RESTful services, ideally with an OpenAPI specification. It supports:

credentials: ZGW auth (JWT based), API key, basic auth, no auth, OAuth 2.0 client credentials flow
custom/self-signed server certificates
mutual TLS (client certificate)
accessing over NLX

class zgw_consumers.models.Service(id, label, uuid, slug, api_type, api_root, api_connection_check_path, auth_type, client_id, secret, oauth2_token_url, oauth2_scope, jwt_valid_for, header_key, header_value, nlx, user_id, user_representation, client_certificate, server_certificate, timeout)[source]

classmethod get_service(url: str) → Self | None[source]

exception NotUpdated

Abstract

The abstract models are used as base classes for the concrete models - you can use them to implement your own service types like SOAPService.

class zgw_consumers.models.abstract.Service(*args, **kwargs)[source]