In This Article

Overview

Important Authentication Update

How to Use the New Authentication Method

Practical Implementation Examples

Next Steps

Overview

This article explains how to authenticate and use your API key when making calls to WiredUp API endpoints. 


Important: WiredUp has updated its API authentication method from URL-based to header-based authentication for improved security.

Important Authentication Update

Effective Date: July 14, 2026

WiredUp is transitioning from URL-based API key authentication to header-based authentication. All integrations must be updated before July 14, 2026, when the old method will stop working.


What's Changing

Old Method (Deprecated - stops working July 14, 2026):

  • API key passed in the URL query string:

e.g. https://your-instance.wiredup.global/api/resource?apiKey=YOUR_KEY

New Method (Required):

  • API key passed in the request header:
URL: https://your-instance.wiredup.global/api/resource
Header: X-PIPWARE-ApiKey: YOUR_KEY

How to Use the New Authentication Method

Step 1: Generate/Obtain Your API Key

See the "How to access/generate your API key" help article: How to access/generate your API Key

Step 2: Structure Your API Request

URL Structure:

https://<your-wiredUp-domain>/<api-endpoint>?param1=value1&param2=value2

Request Header:

X-PIPWARE-ApiKey: <YOUR_API_KEY>

Key Differences:

  • URL: Contains only the endpoint path and query parameters (NO API key)
  • Header: Contains the API key using the header name X-PIPWARE-ApiKey

Practical Implementation Examples

For implementation examples, please refer to: "How to Update Your API Authentication to Request Headers" help article: How to Update Your API Authentication to Request Headers : WiredUp 


Action Required: Before July 14, 2026, update all your API integrations to use the new header-based authentication method. The old URL-based method will no longer work after this date.


Next Steps

If your WiredUp platform has more than one site, you must also include the site name either as:

  • A parameter in the URL, or
  • A header in your API request

See: "How to Authenticate when there is more than one site": How to Authenticate when there is more than one site : WiredUp