🔐 Openapi® CLI

The command-line interface to interact with Openapi® APIs directly from your terminal

Overview

A command-line client for the APIs available at Openapi®. It provides direct terminal access to the Openapi® Marketplace, including token management, scope aliases, and sandbox support. With this CLI you can quickly interact with hundreds of certified APIs and accelerate your digital transformation projects.

Pre-requisites

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

What you can do

With the Openapi CLI, 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
• Query company data, risk reports, automotive records, and more

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

Installation

From source

git clone https://github.com/openapi/openapi-cli.git
cd openapi-cli
cargo install --path .

Or using make:

make install

The binary openapi will be installed in ~/.cargo/bin/.

Build without installing

cargo build --release

The binary will be available at target/release/openapi.

Configuration

The CLI uses two sets of environment variables depending on the type of command.

OAuth credentials (for token management)

Used by openapi token commands. These are your Openapi.it account credentials (Basic auth).

export OPENAPI_USERNAME="your-username"
export OPENAPI_KEY="your-api-key"
export OPENAPI_SANDBOX_KEY="your-sandbox-key"        # optional

Bearer tokens (for service API commands)

Used by all service commands (sms, company, risk, etc.). These are tokens generated via openapi token create.

export OPENAPI_TOKEN="your-bearer-token"
export OPENAPI_SANDBOX_TOKEN="your-sandbox-token"    # optional

Verify your setup

openapi info

This shows all 5 environment variables, their status, and the scopes attached to your tokens.

Sandbox mode

Use the -S (or --sandbox) flag to run against sandbox environments:

openapi -S sms send --to "+391234567890" --message "Test"
openapi -S token list

Token management

# List active tokens
openapi token list

# List all available scopes
openapi token scopes

# Create a new token
openapi token create --scopes "sms"

# Check credit
openapi token credit

# Revoke a token
openapi token revoke --token "token-id"

Scope aliases

When creating tokens with openapi token create --scopes, you can use scope aliases instead of writing full scope strings.

How it works

Each API service is mapped to an alias name. When you use an alias, it automatically expands to all available scopes for that service.

Alias	Service	Domain
ai	AI language models	ai.openapi.com
automotive	Automotive data	automotive.openapi.com
cadastre	Italian cadastral data	catasto.openapi.it
certified-email	PEC / Legalmail	pec.openapi.it
chamber-of-commerce	Chamber of Commerce	visurecamerali.openapi.it
company	Company data	company.openapi.com
docuengine	Official documents	docuengine.openapi.com
domains	.it domain management	domains.altravia.com
esignature	Electronic signature	esignature.openapi.com
exchange-rate	Currency exchange rates	exchange.altravia.com
geocoding	Geocoding	geocoding.openapi.it
invoice	Electronic invoicing	invoice.openapi.com
massive-rem	Massive REM	ws.pecmassiva.com
paying-bills	Bills payment	ws.pagasubito.it
pdf	HTML to PDF	pdf.openapi.it
postal-service	Postal mail	ws.ufficiopostale.com
real-estate	Real estate valuation	realestate.openapi.com
risk	Risk reports and scoring	risk.openapi.com
sdi	SDI electronic invoicing	sdi.openapi.it
sms	SMS messaging	sms.openapi.com
time-stamping	Time stamping	ws.marchetemporali.com
token	OAuth token management	oauth.openapi.it
trust	Trust verification	trust.openapi.com
visengine	Official documents	visengine2.altravia.com
zip-codes	Zip codes and municipalities	cap.openapi.it

Examples

# All SMS scopes
openapi token create --scopes "sms"

# Multiple services
openapi token create --scopes "sms,company"

Method filtering

Prefix an alias with an HTTP method to include only scopes for that method:

# Only POST scopes for SMS
openapi token create --scopes "post:sms"

# Only GET scopes for company
openapi token create --scopes "get:company"

# Mix methods and full aliases
openapi token create --scopes "post:sms,get:company,geocoding"

Supported method prefixes: GET, POST, PUT, PATCH, DELETE.

Case insensitive

Aliases and method prefixes are case insensitive:

openapi token create --scopes "SMS"
openapi token create --scopes "Post:Sms"
openapi token create --scopes "POST:SMS"

All of the above are equivalent.

Literal scopes

If a term does not match any alias, it is passed through as a literal scope:

openapi token create --scopes "sms,GET:imprese.openapi.it/base"

Available commands

Command	Description
info	Show configuration status and readiness
token	OAuth token management
ai	AI language models
automotive	Automotive data (vehicles, insurance)
cadastre	Italian cadastral data
certified-email	Italian certified email (PEC / Legalmail)
chamber-of-commerce	Chamber of Commerce documents
company	Company data and information
docuengine	Official documents (Business Register, Revenue Agency, INPS)
domains	.it domain management
esignature	Electronic signature
exchange-rate	Foreign currency exchange rates
geocoding	Geocoding and reverse geocoding
invoice	Electronic invoicing
massive-rem	Massive Registered Electronic Mail
paying-bills	Bills payment
pdf	HTML to PDF conversion
postal-service	Postal mail service
real-estate	Real estate valuation data
risk	Risk reports and scoring
sdi	SDI electronic invoicing
sms	SMS messaging (v2)
time-stamping	Document time stamping
trust	Trust verification services
visengine	Official documents (Chamber of Commerce, INPS, Tax Agency)
zip-codes	Zip codes, municipalities, provinces, regions

Run openapi --help for the full list, or openapi <command> --help for subcommand details.

Development

# Build
make build

# Run tests
make test-commands

# Download/update OpenAPI specs
make oas-download

Contributing

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

Authors

• Francesco Bianco (@francescobianco)
• Openapi Team (@openapi-it)

Partners

Meet our partners using Openapi or contributing to this project:

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

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.

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