🔐 Openapi® CLI

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

A command-line client for the APIs available at Openapi®. It provides direct terminal access to the Openapi® Marketplace, including OAuth and OAuth v2 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.

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

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. There is also a small terminal easter egg available through openapi --who.

cargo install openapi-cli-rs

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/.

cargo build --release

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

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

Used by openapi oauth and openapi oauthv2 commands. These are your Openapi account credentials (Basic auth).

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

Used by all service commands (smsv2, company, risk, etc.). These are tokens generated via openapi oauth create or openapi oauthv2 tokens create.

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

openapi info

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

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

openapi -S smsv2 send --to "+391234567890" --message "Test"
openapi -S oauth list

# List active tokens
openapi oauth list

# List all available scopes
openapi oauth scopes

# Create a new token
openapi oauth create --scopes "smsv2"

# Check credit
openapi oauth credit

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

# OAuth v2 token creation
openapi oauthv2 tokens create --scopes "smsv2"

# OAuth v2 scopes
openapi oauthv2 scopes list

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

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

# All SMS scopes
openapi oauth create --scopes "smsv2"

# Multiple services
openapi oauth create --scopes "smsv2,company"

# All available scopes (special keyword)
openapi oauth create --scopes "all"

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

# Only POST scopes for SMS
openapi oauth create --scopes "post:smsv2"

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

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

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

Aliases and method prefixes are case insensitive:

openapi oauth create --scopes "SMSV2"
openapi oauth create --scopes "Post:SmsV2"
openapi oauth create --scopes "POST:SMSV2"

All of the above are equivalent.

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

openapi oauth create --scopes "smsv2,GET:imprese.openapi.it/base"

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

# Build
make build

# Run tests
make test-commands

# Download/update OpenAPI specs
make oas-download

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

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

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.

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.

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.