Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.smile.io/llms.txt

Use this file to discover all available pages before exploring further.

Signing keys are used to initialize Smile’s JavaScript SDK and authorize your frontend code to make requests on behalf of a specific customer, allowing you to deeply integrate Smile rewards data and functionality into your website or application. For programmatic access to your account data via Smile’s REST API, use API keys instead.
Feature availability: Signing keys are available on Plus and Enterprise plans.

​
Find your signing keys

To view a list of existing signing keys for your account:
  1. In Smile Admin, navigate to Settings > Developer tools.
  2. Find the card titled Manage signing keys.
If your account has created any signing keys, they’ll be listed within this card.

​
Create a signing key

To create a new signing key:
  1. In Smile Admin, navigate to Settings > Developer tools.
  2. In the Manage signing keys card, click Generate new signing key.
  3. Fill in the Name field with a value that represents how and where the signing key will be used (e.g. “main website” or “marketing landing page”).
  4. Click Generate.
  5. Copy the provided Signing key value to a safe place.
Important: For security reasons, you won’t be able to see the signing key value again after the initial creation, so make sure to save it in a safe place! We recommend a password manager like 1Password.

​
Edit a signing key

For security reasons, it is not possible to edit a signing key after it has been created.
Tip: If you need to change the name for a signing key, just create a new signing key instead, and then delete the old signing key.

​
Delete a signing key

To delete an existing signing key:
  1. In Smile Admin, navigate to Settings > Developer tools.
  2. In the Manage signing keys card, locate the signing key that you wish to delete.
  3. Beside the key you wish to delete, click the delete icon.
  4. Type the full name of the signing key and click Permanently delete.
Caution: Once a signing key is deleted, it will immediately stop functioning. Be sure to update any websites or surfaces using the signing key before deleting the signing key itself.