TIBCO Cloud API Management: How to configure and use 'noapikey' as a Package Key?

TIBCO Cloud API Management: How to configure and use 'noapikey' as a Package Key?

book

Article ID: KB0072003

calendar_today

Updated On:

Products Versions
TIBCO Cloud API Management -

Description

When the PackageKey or APIKey is 'noapikey', the request to TIBCO Cloud API Management(CAPIM) or CAPIM-Local Edition (CAPIM-LE) does not need to carry an apiKey for authentication.
This is usually used in lower environments, for quickly testing traffic calls or for traffic calls that are used to check availability of an API/Endpoint.

Environment

All Supported Platforms

Resolution

#Endpoint
- When configuring the endpoint, the option 'Allow Calls having no API Key' should be enabled in the "More Settings"/ "More" screen
- In the "Key & Method Detection" / "Protocol & Authentication" screen, 'Parameters' should be selected for "Developer's API Key Location"

#Package & Plan
- Create Package and Plan as any regular ones.
- Do not select 'Generate Shared Secret' in the Package's 'Key Properties'.
- Using 'noapikey' or some such moniker in the names helps for better management/identification.

#Application & Package Key
- When creating the PackageKey, the value of the key should be: noapikey

Issue/Introduction

This article provides steps to use 'noapikey' as an API Key.