Autenticação

Envie a chave#

Mande a chave em toda requisição, com o prefixo Bearer:

Authorization: Bearer mvk_live_xxx

A chave tem o formato mvk_live_ seguido de 43 caracteres base64url. Cada chave pertence a uma loja só, e a API responde com os dados dessa loja.

Escopos#

Cada chave tem uma lista de escopos, escolhida na criação. Um endpoint só responde se a chave tiver o escopo dele.

Escopos da v1

orders:readescopo

Ler pedidos e o resumo de pedidos: GET /v1/orders, GET /v1/orders/{id} e GET /v1/orders/summary.

store:readescopo

Ler os dados da loja: GET /v1/store.

Crie a chave só com os escopos que o seu sistema usa.

Criar e revogar chaves#

• As chaves ficam em Configurações → Chaves de API. Só quem tem o papel Manager na loja vê essa página, cria e revoga chaves.
• Para criar, clique em Nova chave, dê um nome e marque as permissões (orders:read, store:read).
• A chave em texto aparece uma vez, na criação, com o botão Copiar chave. A Movvio guarda só um hash dela e não consegue mostrar a chave de novo.
• Cada loja pode ter até 10 chaves ativas. Revogue uma para liberar espaço.
• A lista de chaves mostra o começo de cada uma (como mvk_live_ab12…) e quando foi usada pela última vez.
• Para revogar, clique em Revogar na linha da chave e confirme. Ela para de funcionar na hora e passa a responder 401.
• Se uma chave vazar, revogue e crie outra.

Erros de autenticação#

• 401 com api_key_missing: a requisição veio sem o header Authorization.
• 401 com api_key_invalid: a chave não existe, está mal formada ou foi revogada. A resposta não diz qual dos casos é.
• 403 com insufficient_scope: a chave é válida, mas não tem o escopo do endpoint.
• 403 com browser_request_forbidden: a requisição veio de um navegador.

O formato completo está em Erros.