In This Article
Why is this change being made?
When will the old method stop working?
Overview
This article explains the change to how the WiredUp API handles authentication. The URL-based API key method is being phased out in favour of a more secure header-based method. Both methods currently work, however the old method will stop working on 14 July 2026.
What is changing?
We are moving away from sending the API key as part of the web address (URL) to a more secure method where the API key is sent in the request header instead, keeping it hidden from logs and browser history.
- Old method (being phased out):
- DownloadCopy code
- GET /api/resource?apiKey=your-key
- New method (required from 14 July 2026):
- DownloadCopy code
- X-PIPWARE-ApiKey: your-key
Why is this change being made?
Sending API keys in the URL is a security risk. URLs can appear in:
- Server logs
- Browser history
- Proxy logs
- Error messages
This can expose your credentials in places they should not be visible. The header-based method keeps your API key hidden and your data secure.
Am I affected?
You may be affected if:
- Your team has custom integrations that connect to the WiredUp API
- You have automated scripts or scheduled jobs that call WiredUp API endpoints
- You have third-party tools configured to connect to WiredUp via API
What is NOT affected?
- Regular WiredUp users — If you access WiredUp through the browser as a normal user, nothing changes for you
- Integrations already using the header method — If your integration already sends the API key in the request header, no changes are needed
- All existing data — This change only affects how API calls are authenticated, not any data in the system
What should I do?
Recommended Action
Ask your technical team to update any API integrations to use the new header-based authentication method before 14 July 2026.
Steps:
- Identify any integrations, scripts, or tools that connect to the WiredUp API
- Check whether they currently send the API key in the URL
- Update them to send the API key in the request header instead:
- DownloadCopy code
- X-PIPWARE-ApiKey: your-key
- Test the updated integration to confirm it works correctly
- Remove the old URL-based API key parameter
What NOT to do
- Do not wait until after 14 July 2026 to make this change — your integrations will stop working
- Do not continue using the old method in production — it will display a deprecation warning and will stop working on 14 July 2026
When will the old method stop working?
Date | What happens |
14 April 2026 | New header-based method deployed. Both methods work. Old method shows deprecation warning. |
14 July 2026 | Old URL-based method fully deprecated. Only header-based method accepted. |
Frequently Asked Questions
Q: I'm seeing a deprecation warning — what does it mean?
A: A deprecation warning means your integration is still using the old URL-based method. It is a reminder to update before 14 July 2026. Your integration will continue to work until that date.
Q: How long will this change take to implement?
A: For most integrations this is a small, quick code change — typically updating a single line or configuration setting. Your technical team should be able to implement and test this quickly.
Q: What happens if I don't make the change before 14 July 2026?
A: After 14 July 2026, API calls using the old URL-based method will stop working and return an authentication error, causing disruption to your integrations. We strongly recommend updating before the deadline.
Q: How do I know if my integration is using the old method?
A: Check whether your API calls include ?apiKey= or &apiKey= in the URL. If they do, your integration needs to be updated.
Q: Will this affect my data?
A: No. This change only affects how API calls are authenticated. All your data remains unchanged.
Q: Can I test the new method before switching over?
A: Yes. Both methods currently work, so you can update and test your integration at any time before the 14 July 2026 deadline without any risk of disruption.
Need Help?
If you have questions about:
- Whether your specific integrations are affected
- How to update your integration to use the new method
- Testing your updated integration
Please contact our support team at support@wiredup.global