Getting Started

This guide provides a step-by-step overview of how to obtain your API credentials and successfully make your first request using the Passwave platform. By following these instructions, you’ll gain a clear understanding of the authentication process and learn how to start integrating Passwave’s API into your application.

Step 1: Generate API Credentials

Log into the Passwave Dashboard and navigate to Settings → API Credentials. Click Generate New Credential to create a new API key.

Select an environment: Development for sandbox testing, or Production for live properties. Development credentials use the sandbox API endpoint where all operations are simulated. Production credentials connect to your real properties and devices.

Store your credentials securely in environment variables:

export PASSWAVE_PARTNER_ID="prtn_xxxxxxxxxxxxx"
export PASSWAVE_API_KEY="sk_xxxxxxxxxxxxx"

Never commit credentials to version control.

Step 2: Authenticate Requests

Every API request requires two headers: Authorization with your API key as a Bearer token, and X-Partner-ID with your Partner ID.

curl -X GET "https://api.passwave.com/v1/properties" \
  -H "Authorization: Bearer sk_xxxxxxxxxxxxx" \
  -H "X-Partner-ID: prtn_xxxxxxxxxxxxx"

Step 3: Test Your Setup

Retrieve your organization's properties list to verify authentication:

curl -X GET "https://api.passwave.com/v1/properties" \
  -H "Authorization: Bearer sk_xxxxxxxxxxxxx" \
  -H "X-Partner-ID: prtn_xxxxxxxxxxxxx"

A successful response returns:

{
  "status": "success",
  "data": {
    "items": [
      {
        "id": "prop_123",
        "name": "Grand Hotel Downtown",
        "type": "hotel"
      }
    ],
    "pagination": {
      "page": 1,
      "total": 1
    }
  }
}

All API responses follow this format: a status field indicating success or error, and a data object with the response payload. All timestamps are ISO 8601 UTC.

What's Next

You're authenticated and ready to build. Explore the Concepts section to understand the core entities, or jump to API Reference to start creating credentials.