App do seller (1.0)
O app de lojista da plataforma 1.0 e as rotas que o mantêm funcionando: envelope, autenticação, nomes alternativos e mapa das operações.
Na plataforma 1.0 o seller (lojista) tinha um aplicativo de celular para ver o painel, atender chats e cuidar da empresa. Esse app chama URLs derivadas do nome interno de cada tela, como vn_login_api e vn_dashboard_api. A Venddor manteve essas rotas para que os apps já publicados continuem funcionando, e acrescentou nomes mais claros (vendor_login, vendor_dashboard...).
Como funciona
O envelope
{ "status": 200, "data": { "success": true, "message": "", "...": "campos da operação" } }status é sempre 200. Em falha de negócio, data.success é false e data.message explica em inglês (texto fixo, não traduzido). Em alguns casos vem também data.action: "logout".
O fluxo do app
- Abrir o app
vendor_startdevolve moeda e idiomas. - Entrar
vendor_logindevolve oaccess_tokendo seller e o blocovendor_data. Quem ainda não tem conta usavendor_signup. - Usar o painel
Com
Authorization: Bearer <access_token>, o app lê painel e avisos, empresa e perfil e chats.
Conceitos importantes
Quem pode chamar
As rotas, exceto login, cadastro e recuperação de senha, só aceitam um token de seller (ou de administrador). Um token de cliente recebe 403. Mesmo assim, várias operações precisam de um usuário ligado a um seller ativo: com token de administrador respondem success: false e action: "logout".
Dinheiro e datas
Valores em dinheiro saem como string decimal ("182340.50"). Datas saem em RFC 3339 (UTC) ou Unix, conforme a operação, indicado em cada página.
Ids
Ids de seller e de conversa são UUID.
O que não está nesta seção
As operações de produtos, pedidos e upload do mesmo app (vendor_products, vendor_orders, vendor_upload e afins) não fazem parte desta seção.
Endpoints
| Operação | Nomes | Página |
|---|---|---|
| Login (POST) e recuperação de senha (PUT, esboço) | vendor_login, vn_login_api | Login e cadastro |
| Cadastro de seller (POST) | vendor_signup, vn_signup_api | Login e cadastro |
| Configuração do app (GET) | vendor_start, vn_start_api | Início, painel e avisos |
| Painel (GET) | vendor_dashboard, vn_dashboard_api | Início, painel e avisos |
| Avisos (GET) | vendor_notifications, vn_communication_api | Início, painel e avisos |
| Empresa (GET, PUT) | vendor_company, vn_company_api | Empresa e perfil |
| Perfil (GET, PUT) | vendor_profile, vn_profile_api | Empresa e perfil |
| Chats (GET, POST) | vendor_chats, vn_chats | Chats |
| Leilões (GET, POST, esboço) | vendor_auctions, vn_auction_api | Leilões |
Erros comuns
- Chamar
vendor_loginsem nenhuma credencial. Responde 401 antes de chegar ao login. Envie a credencial de serviço do app. - Checar só o status HTTP. Falha de negócio também é
200; leiadata.success. - Testar com token de administrador.
vendor_dashboardevendor_companyrespondem "User is not a vendor". Use um usuário de seller. - Esperar
fcm_tokenregistrado. O login aceita o campo e o ignora. - Esperar recuperação de senha. O
PUTdo login sempre responde que não está disponível.