Addons by Reinos

Appearance

Key / Secret ​

The key and secret are designed to setup a simple authentication with a key and secret combination.

WARNING

Since v10.0.0 the secret is stored as a hash and is no longer shown on the edit page of the member (Breaking change). Existing secrets keep working.

When a member is created in the webservice module, the module automatically creates a key and secret combination, unique for every member. After saving the new member the key and secret are shown once in a message at the top of the page, copy them right away. Only a hash of the secret is stored, so it cannot be shown again.

The key stays visible on the edit page of the member, in the Credentials panel below the member settings.

title

Regenerate the secret ​

Replace a lost or leaked secret with Regenerate secret in the Credentials panel of the member and confirm. The new key and secret are shown once, the old secret stops working right away, so update the clients that use it. Available from v10.0.0

Use the key and secret ​

Send the key and secret via the headers (Available from v9.3.0):

bash
curl -G 'https://your-domain.com/index.php/webservice/entry' \
  -H 'X-Api-Key: 881ffcf82e41db00c3f00710f467e818' \
  -H 'X-Api-Secret: 76a7646899af288589c4b69be484879e' \
  --data-urlencode 'data[entry_id]=1'

Or via the auth object:

https://your-domain.com/index.php/webservice/entry?auth[key]=881ffcf82e41db00c3f00710f467e818&auth[secret]=76a7646899af288589c4b69be484879e&data[entry_id]=1

Since v9.3.0 new keys and secrets are generated with a secure random generator. Existing keys and secrets keep working.