Supply Lens

How do I change the password or API key for an Integration?

Update integration credentials

Correct or replace the credentials an Integration uses, without removing and reconnecting it.

About 3 min

If someone has rotated an API key, changed a password, or you typed a credential wrong when you connected, you can fix it on the Integration's Credentials card. You don't need to remove and reconnect the Integration, so its Configurations, schedule and Mappings stay as they are.

Before you start

  • The new credentials from the other system, for example a regenerated API key. If you don't manage that system, ask whoever does.
  • Access to Settings → Integration setup → Integrations in Supply Lens.

Steps

  1. Go to Settings → Integration setup → Integrations.
  2. Click the Integration to expand its tile.
  3. Open the Credentials card. Here you can view, add, edit and remove the credentials the Integration uses.
  4. Edit the credential that has changed and enter the new value. Use the show button beside a secret field to check what you've pasted.
  5. Save your change.
  6. Under Manual Operation, click Run send & receive to test the connection straight away.

Uninstalled Integrations

If the Integration shows a grey Uninstalled label, the connection was removed on the other system's side and its settings can't be changed. Reconnect it from that system. For Shopify, the Supply Lens app in your Shopify admin can reconnect an uninstalled store.

Check it worked

  • After the manual run, new data arrives from the system, or waiting Target Data is sent and shows Sent.
  • Any Documents that failed while the credentials were wrong can now be reprocessed.

If something goes wrong

  • It still won't connect. In the other system, check that API access is enabled, the key hasn't been revoked, and the user or app Supply Lens connects as still has the permissions it needs.
  • The Integration is disabled. Check Activation is set to Enabled.
  • Still stuck. See Fix connection or login failures, or email support@supplylens.co.uk with the Integration Id from the tile.

Tip

Agree with whoever manages your other systems that if they rotate a key or change the user Supply Lens connects as, they update the Integration's credentials at the same time, or tell you first.