Skip to main content
Feedback

API Package Key Properties

The Package Key is generated for developers to access a specific Package and its associated Plan. A key adapter and other key properties can be set on the Key Properties page.

The following table describes the fields on the API Package Key Properties page.

FieldDescription
Key Length

The number of characters in the key.

Note:

1. The default key length for an API Package and Plan created in Cloud API Management is 24 characters. You can use longer or shorter custom values.

2. The default key length for an API Package and Plan generated in Cloud API Management via API Control Plane is 64 characters.

Generate Shared SecretGenerates a shared secret and enables the Shared Secret Length option.
Shared Secret Length

The number of characters that Cloud API Management's own algorithm uses to generate a shared secret for a key. This shared secret is a password that is known only to the developer. A shared secret can be used in a digital signature to provide more secure authentication for an API call.

Note:

1. The default shared secret length for a key created in Cloud API Management is 10 characters.

2. The default shared secret length for a key generated in Cloud API Management via API Control Plane is 64 characters.

Package Key Adapter

Populated whenever a custom algorithm is required to generate a key. During the implementation phase of client service, the Cloud API Management Engineer writes a custom algorithm according to the client's requirements.

Note: The information in the Package Key Adapter must only be changed by the Cloud API Management Engineer. Before making any changes, consult Boomi Account Representative.