Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document app authentication flow and publishing #3

Open
leomp12 opened this issue Mar 4, 2020 · 1 comment
Open

Document app authentication flow and publishing #3

leomp12 opened this issue Mar 4, 2020 · 1 comment

Comments

@leomp12
Copy link
Member

leomp12 commented Mar 4, 2020

We need a richer documentation (not only Store API mentions) for app creators:

  • Authentication flow explanation (with images);
  • Publish to Market for merchant installation;
  • Paragraph about Application Starter and benefits;
  • Videos with Application Starter and from scratch using some tool to debug requests;

Public RequestBin endpoint is a seems to be a good option for examples:
https://requestbin.com/r/enwoke6mykn58

@leomp12
Copy link
Member Author

leomp12 commented Mar 4, 2020

Arquivando uma conversa por e-mail sobre isto

Como eu registro um app dentro da plataforma de vocês? Dei um olhada no resource applications da api, porém na verdade o que a api faz é manipular as instalações de apps dentro de uma loja específica.

Exatamente, no resource applications você só instala o aplicativo dentro da respectiva loja.
Assim que instalado, se o body do aplicativo tiver os campos de autenticação uma primeira requisição (POST) será enviada para o auth_callback_uri, a partir daí você segue o fluxo de autenticação de app para atualizar seu token de acesso:
https://developers.e-com.plus/docs/api/#/store/authenticate-app/authenticate-app
O boilerplate abstrai esta configuração do body e o processo de manutenção dos tokens por loja.

Para que o lojista possa instalar o aplicativo pelo painel o app deve estar publicado no Market https://market.e-com.plus/ , e para fazer isto você precisa de uma conta de parceiro. Chegou a preencher o formulário de cadastro aqui https://docs.google.com/forms/d/e/1FAIpQLSfd8uUsMG6N_rSFi2blGuk3Rfqi_BPp6fxschkmkdhEBVDsyw/viewform?

Qual a url de autorização de instalação eu devo direcionar meu usuário para que seja autorizada a instalação do app?

Vai depender do app_id ou slug do aplicativo:
https://app.e-com.plus/#/apps/edit/:app_id

Com a conta de parceiro você poderá publicar o app logando no próprio https://market.e-com.plus/ , mas eu sugiro que você não se preocupe com isto por enquanto, sugiro que construa e teste o aplicativo primeiro (o body e os endpoints do seu lado).

Utilize uma conta demo para testar seu aplicativo (login: teste, senha: teste), você pode gerar o access token para a Store API pelo fluxo normal de autenticação de admin:
https://developers.e-com.plus/docs/api/#/store/authenticate-yourself/authenticate-yourself

Com este token em mãos você cria o aplicativo ainda pela Store API na loja demo:
https://developers.e-com.plus/docs/api/#/store/applications/new-application

Se tudo funcionar bem, o próximo passo é publicar no Market para que os lojistas possam instalar.

Notas:

  • Se você estiver usando o boilerplate ele vai gerar automaticamente o body pro seu aplicativo (conforme sua configuração) em assets/application.json, este body você usa no POST /applications.json;
  • Em breve vamos implementar no boilerplate uma pipeline para publicação do aplicativo no Market automaticamente após cada nova versão Market CI application-starter#4 , neste caso você nem precisará se preocupar com isto, apenas com o app;

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant