Authentication

The Wave API uses a single API key. Generate one in the Wave Console and send it as the X-API-Key header on every request:

curl https://{base-url}/lines \
  -H "X-API-Key: YOUR_API_KEY"

Keep your API key confidential and do not share it with anyone. If you believe a key has been exposed, generate a new one in the Wave Console.

Getting an API key

Keys are issued per partner in the Wave Console, under Parceiros → Configurações → Segurança & Acesso → Chaves de API. The value is shown only once, right after the key is created.

Generate an API key

Step-by-step guide to creating a key in the Wave Console, storing its value, and revoking keys you no longer use.

Scoping requests to a broker

A broker is a partner/reseller entity in the Wave platform. Some endpoints accept an optional x-broker-id header to scope the request to one broker’s data.

curl https://{base-url}/holders \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "x-broker-id: YOUR_BROKER_ID"

Having trouble generating or using an API Key? Contact us through our support portal.

API Documentation

Holders

Lines

Subscriptions

Usage

Portability

Catalog

Payments

Tax Receipts

Inventory

Orders

Getting an API key

Generate an API key

Scoping requests to a broker

​Getting an API key

Generate an API key

​Scoping requests to a broker

Getting an API key

Scoping requests to a broker