Openapi® client for Python

The perfect starting point to integrate Openapi® within your Python project

Overview

A minimal and agnostic Python SDK for Openapi, inspired by a clean client implementation. This SDK provides only the core HTTP primitives needed to interact with any Openapi service.

Pre-requisites

Before using the Openapi Python Client, you will need an account at Openapi and an API key to the sandbox and/or production environment

Features

• Agnostic Design: No API-specific classes, works with any OpenAPI service
• Minimal Dependencies: Only requires Python 3.8+ and requests
• OAuth Support: Built-in OAuth client for token management
• HTTP Primitives: GET, POST, PUT, DELETE, PATCH methods
• Clean Interface: Similar to the Rust SDK design

What you can do

With the Openapi Python Client, you can easily interact with a variety of services in the Openapi Marketplace. For example, you can:

• 📩 Send SMS messages with delivery reports and custom sender IDs
• 💸 Process bills and payments in real time via API
• 🧾 Send electronic invoices securely to the Italian Revenue Agency
• 📄 Generate PDFs from HTML content, including JavaScript rendering
• ✉️ Manage certified emails and legal communications via Italian Legalmail

For a complete list of all available services, check out the Openapi Marketplace 🌐

Installation

The package is available on PyPI and supports Python 3.10 and above. Install it with pip:

pip install openapi-python-sdk

If you are using Poetry:

poetry add openapi-python-sdk

No additional configuration is needed. The only runtime dependency is httpx.

Usage

Interaction with the Openapi platform happens in two distinct steps.

Step 1 — Generate a token

Authenticate with your credentials and obtain a short-lived bearer token scoped to the endpoints you need.

from openapi_python_sdk.client import OauthClient

oauth = OauthClient(username="<your_username>", apikey="<your_apikey>", test=True)

resp = oauth.create_token(
    scopes=[
        "GET:test.imprese.openapi.it/advance",
        "POST:test.postontarget.com/fields/country",
    ],
    ttl=3600,
)
token = resp["token"]

# Revoke the token when done
oauth.delete_token(id=token)

Step 2 — Call an API endpoint

Use the token to make authenticated requests to any Openapi service.

from openapi_python_sdk.client import Client

client = Client(token=token)

# GET with query params
resp = client.request(
    method="GET",
    url="https://test.imprese.openapi.it/advance",
    params={"denominazione": "altravia", "provincia": "RM", "codice_ateco": "6201"},
)

# POST with a JSON payload
resp = client.request(
    method="POST",
    url="https://test.postontarget.com/fields/country",
    payload={"limit": 0, "query": {"country_code": "IT"}},
)

Testing

Install dev dependencies and run the test suite:

pip install pytest
pytest

Or with Poetry:

poetry install
poetry run pytest

Contributing

Contributions are always welcome! Whether you want to report bugs, suggest new features, improve documentation, or contribute code, your help is appreciated.

See docs/contributing.md for detailed instructions on how to get started. Please make sure to follow this project's docs/code-of-conduct.md to help maintain a welcoming and collaborative environment.

Authors

Meet the project authors:

• Michael Cuffaro (@maiku1008)
• Openapi Team (@openapi-it)

Partners

Meet our partners using Openapi or contributing to this SDK:

• Blank
• Credit Safe
• Deliveroo
• Gruppo MOL
• Jakala
• Octotelematics
• OTOQI
• PWC
• QOMODO S.R.L.
• SOUNDREEF S.P.A.

Our Commitments

We believe in open source and we act on that belief. We became Silver Members of the Linux Foundation because we wanted to formally support the ecosystem we build on every day. Open standards, open collaboration, and open governance are part of how we work and how we think about software.

License

This project is licensed under the MIT License.

The MIT License is a permissive open-source license that allows you to freely use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, provided that the original copyright notice and this permission notice are included in all copies or substantial portions of the software.

In short, you are free to use this SDK in your personal, academic, or commercial projects, with minimal restrictions. The project is provided "as-is", without any warranty of any kind, either expressed or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

For more details, see the full license text at the MIT License page.