Cadastrar Aplicativo de Integração
Este guia detalha o fluxo de criação de aplicativos voltados para a gestão de pedidos, cardápios e logística, agora com um fluxo direto para o ambiente de produção.
Passo 1: Seleção do Tipo de Aplicativo
Ao iniciar um novo cadastro no portal, você deve escolher a categoria correta para sua solução.
- Ação: Selecione a opção "Aplicativo de Integração".
- Regra: Este fluxo é exclusivo para parceiros que desejam gerenciar o funcionamento interno de lojas (pedidos e itens) via API V2.
Passo 2: Preenchimento das Informações Gerais
Nesta etapa, você define os dados técnicos e de contato da sua integração.
- Dados Obrigatórios: Nome do aplicativo, e-mail para contato, URL de redirecionamento (para o código de autorização) e o CNPJ do parceiro.
- Validação de CNPJ: O sistema validará o CNPJ automaticamente. Se for inválido, a criação não será permitida.
- Categorias Disponíveis: Escolha entre Restaurantes (Cardápio), Mercados/Farmácias (Catálogo), Logística ou Parceiro de Soluções.
- Seleção de Escopos (API V2): Marque quais dados sua aplicação precisará acessar: Gestão de Loja, Pedidos ou Itens.
Passo 3: Identidade Visual e Termos
Configure como sua aplicação será apresentada e garanta a conformidade com os padrões da marca.
Diretrizes de Design (Obrigatório): É fundamental que sua aplicação siga as Diretrizes de Design na Criação de Apps. Essa norma abrange interface, nomenclatura do aplicativo, padrão de logotipo e clareza nas URLs de Política de Privacidade e Termos de Uso. Siga estas diretrizes para garantir a aprovação em produção.
- Descrição do Aplicativo: Insira o texto detalhando as funcionalidades da sua solução.
- Assets: Faça o upload do ícone (logotipo).
- Documentação Legal: Informe as URLs da sua Política de Privacidade e dos Termos de Uso.
Passo 4: Revisão e Obtenção de Credenciais
Antes de finalizar, o sistema apresentará um resumo de todos os dados inseridos.
- Preview: Revise todas as informações para garantir que o redirecionamento e os escopos estão corretos.
- Geração de Credenciais: Ao confirmar, o sistema gerará imediatamente o Client ID e o Client Secret.
Nota de Segurança: Guarde essas credenciais em local seguro; elas são únicas para sua aplicação.
Ciclo de Vida e Homologação
Após a criação, sua aplicação passará pelos seguintes estados:
1. Estado de Rascunho (Draft)
- Edição: Enquanto estiver em rascunho, você tem liberdade total para editar qualquer campo.
- Isolamento: O aplicativo não é visível para nenhum lojista (Seller) da base produtiva neste estágio.
- Testes em Produção (Loja de Teste): Para validar sua aplicação antes da aprovação geral, você pode gerar o código de autorização (
AUTHORIZATION_CODE) diretamente no portal para as Lojas de Teste vinculadas à sua conta. Isso permite testar o fluxo completo de integração em ambiente real, garantindo que tudo funcione antes de solicitar a homologação.
2. Solicitação de Homologação
- Gatilho: Quando a configuração estiver pronta, clique em "Solicitar Aprovação" no dashboard.
- Análise: O status mudará para "Em Revisão", e o time Aiqfome analisará os dados. Durante este período, a edição fica bloqueada.
3. Publicação e Produção
- Aprovação: Se aprovado, o status muda para "Publicado". Suas credenciais agora podem ser usadas para integrar lojas reais.
- Imutabilidade: Uma vez publicado, não é permitida a edição direta de campos para garantir a segurança dos lojistas.
Importante: Diferente dos Apps de Marketplace, o App de Integração não possui opção de desativação pelo parceiro, devido ao risco operacional para as lojas conectadas.
4. Reprovação
- Caso o app seja reprovado, você receberá o Motivo da Reprovação.
- Você poderá retornar o app para o estado de Rascunho para realizar as correções necessárias e submeter novamente.