Create and revoke API keys

An API key is a password that lets a system talk to Provei on behalf of your store. You create and revoke keys in Conta › Desenvolvedor (Account › Developer). Each key is shown only once, right after you create it.

Caution

The key is a password. Use it only on your store’s server, never in your website code, theme, apps or shared spreadsheets. The try-on installation code doesn’t need a key.

What keys are for

• Importing products from a link or a spreadsheet. Without an active key, the import shows Para importar por link ou planilha, sua loja precisa de uma chave de acesso. Crie uma em Desenvolvedor. (To import from a link or spreadsheet, your store needs an access key. Create one in Desenvolvedor.) See Add from a link and Add from a spreadsheet.
• Your own integrations. Your store’s system can call the Provei API. Each try-on made through the API uses credits from your plan. For the technical details, see Developers.

Don’t see Desenvolvedor in the menu? This feature is turned on by Provei. Contact support to turn it on.

Create a key

1. In Conta › Desenvolvedor, click Criar chave (Create key).

2. In Nome (opcional) (Name, optional), write where the key will be used, for example “Servidor da loja” (Store server). This helps you know where each key is in use.

3. Click Criar chave.

4. In the Copie sua chave agora (Copy your key now) window, click Copiar chave (Copy key) and keep it somewhere safe, such as your team’s password manager.

5. Click Pronto (Done).

For security, the key isn’t shown again. If you lose it, create another one.

See your keys

For each key, the list shows the name, the start of the key followed by ••••, the Situação (Status: Ativa, active, or Revogada, revoked), when it was Criada (Created) and its Último uso (Last used).

Revoked keys are hidden. Click Mostrar N chaves revogadas (Show N revoked keys) to see them.

Revoke a key

1. On the key’s row, click Revogar (Revoke).

2. Confirm with Revogar chave (Revoke key).

Systems using that key stop working right away. This can’t be undone.

Danger

If every key is revoked, try-on generation may stop. Create the new key before you revoke the old one.

Replace a key (rotation)

Replace a key when someone who knew it leaves the team, when it may have leaked, or every so often.

1. Create a new key.

2. Swap the old key for the new one in every system that uses it.

3. Check that those systems work with the new key. The new key’s Último uso starts updating.

4. Revoke the old key.

See more precautions in Good practices for keys.

Frequently asked questions

I lost my key. Can I see it again?

No. For security, the key is shown only once, right after you create it. Create a new key, swap it into the systems that used the old one and revoke the old one.

Do I need a key to import products?

Yes. To import from a link or a spreadsheet, your store needs an active key. Create one in Conta › Desenvolvedor (Account › Developer).

Can I use the key in my website code?

No. The key is a password for your account and must stay on your server only. The try-on installation code doesn't need a key.

See also

• Best practices for API keys and access
• Developers: integrate the try-on
• Add products with a spreadsheet
• Add products by store link