Seguir

Obtendo Credenciais para API

Neste artigo serão apresentados os principais detalhes e indicativos de como obter as credenciais para uso da API do Eccosys.

O Eccosys aceita dois tipos de autenticação: um par de API Key e Signature (criada a partir de uma secret key) ou JWT. Abaixo os passos para obter cada uma das formas.

Par de API Key e Signature

Com esse método de autenticação, somente aplicativos externos podem ter acesso à API, ou seja, usuários normais não conseguem ter essas credenciais.

Obtendo a API Key

Acesse Configurações > E-commerce > API para Web Services. Essa chave é única para seu ambiente Eccosys, então se ela já estiver gerada, basta copiá-la. Se ela não estiver gerada ainda, é só clicar no botão Gerar

Sele__o_375.png

Obtendo a Secret Key

Acesse Configurações > E-commerce > Aplicativos Externos. Essa chave é única para o aplicativo que irá integrar com seu ambiente, então você terá que criar um registro novo. Para isso, siga os seguintes passos:

1 - Clique em Incluir um Aplicativo

Sele__o_377.png

2 - Coloque um nome que identifique o aplicativo (recomendamos que seja no formado nomeDoIntegrador-nomeDeSuaEmpresa)

Se você clicar fora do campo, a chave secret já será gerada. Essa chave é feita a partir do Nome da Aplicação, então é importante não alterar esse nome após entregar essa chave ao integrador, pois a integração irá parar de funcionar se isso for feito.

Sele__o_378.png

3 - Salve o cadastro

Sele__o_379.png

JWT

Com a autenticação JWT, tanto usuários normais, quanto aplicativos externos, podem consumir a API do Eccosys.

Obtendo o Token para um usuário

Acesse Configurações > Usuários e Acessos, abra o menu de contexto do usuário que deseja criar um token e clique em Gerar Token API. Será aberta uma caixa de diálogo com o token. Esse token não é salvo no Eccosys, então você deve copiá-lo e armazená-lo:

Screenshot_from_2018-04-17_10-01-14.png

Screenshot_from_2018-04-17_10-01-20.png

Screenshot_from_2018-04-17_10-01-31.png

 Somente o usuário Admin principal consegue criar tokens para usuários.

Obtendo o Token para um Aplicativo Externo

Acesse Configurações > E-commerce > Aplicativos Externos. O aplicativo externo já deve estar salvo no Eccosys para poder obter seu token. Basta clicar no botão Gerar Token JWT:

Screenshot_from_2018-04-17_10-19-28.png

Screenshot_from_2018-04-17_10-19-37.png

É importante notar que somente será válido um token por vez, então sempre que um novo token é gerado, o anterior deixa de ser válido.


Pronto, agora você já pode passar essas informações para o integrador que deseja se comunicar com o seu Eccosys! 

Lembrando que, caso você não encontrou algum dos módulos indicados nesse artigo, é só entrar em contato com o nosso suporte que habilitaremos o módulo para você.

Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 0
Tem mais dúvidas? Envie uma solicitação

0 Comentários

Por favor, entre para comentar.
Powered by Zendesk