BeeFoodDevelopers
Entrar ou criar acesso

Scopes e permissões

Cada credencial precisa ter permissão para o recurso e a operação solicitados.

Leitura e escrita

Todo scope tem o formato <recurso>:<operação>, e a operação é sempre leitura ou escrita. Ela define o que a credencial pode fazer com as rotas daquele recurso — não com o restaurante inteiro.

As rotas de leitura mostram o restaurante sem alterá-lo: listam e detalham pedidos, produtos, cupons e dados que já existem. São o nível certo para painéis, relatórios e sincronizações, e não criam, alteram nem removem nada.

As rotas de escrita agem sobre o restaurante: criam, atualizam e excluem registros. Por isso o <recurso>:write deve estar apenas na credencial da integração que realmente vai operar naquele recurso — um erro de escrita muda o cardápio, o cupom ou o pedido de verdade.

Escrita inclui leitura: quem tem <recurso>:write também acessa as rotas <recurso>:read. O caminho natural é começar com leitura e pedir escrita quando a integração precisar agir.

Cores dos escoposrecurso:readleitura — só consultamrecurso:writeescrita — alteram o restaurante

Permissões por recurso

RecursoLeituraEscrita
Restaurantestore:readstore:write
Cuponscoupons:readcoupons:write
Avaliaçõesreviews:readreviews:write
Pedidosorders:readorders:write
Clientescustomers:readcustomers:write
Catálogocatalog:readcatalog:write
Entregadores (em breve)drivers:readdrivers:write
Estoque (em breve)stock:readstock:write

Escrita inclui leitura: quem tem <recurso>:write também acessa as rotas de <recurso>:read.

Restaurante — store:read

PáginaRotaEscopo
Listar merchantsGET/v1/store/merchantsstore:read
Detalhe do merchantGET/v1/store/merchants/{merchantId}store:read
Canal deliveryGET/v1/store/merchants/{merchantId}/deliverystore:read
Horários do deliveryGET/v1/store/merchants/{merchantId}/delivery/opening-hoursstore:read
Recebimentos do deliveryGET/v1/store/merchants/{merchantId}/delivery/payment-methodsstore:read
Pagamento onlineGET/v1/store/merchants/{merchantId}/delivery/online-paymentsstore:read
Área de entregaGET/v1/store/merchants/{merchantId}/delivery/delivery-areastore:read
Canal presencialGET/v1/store/merchants/{merchantId}/localstore:read
Horários do presencialGET/v1/store/merchants/{merchantId}/local/opening-hoursstore:read
Formas de pagamentoGET/v1/store/payment-methodsstore:read

Pedidos — orders:read / orders:write

PáginaRotaEscopo
Listar pedidosGET/v1/ordersorders:read
Polling de pedidosGET/v1/orders/pollingorders:read
Detalhe do pedidoGET/v1/orders/{orderId}orders:read
Resumo de pedidosGET/v1/orders/summaryorders:read
Resumo agrupadoGET/v1/orders/summary/groupedorders:read
Vendas por setorGET/v1/orders/summary/sectorsorders:read
Vendas por produtoGET/v1/orders/summary/productsorders:read
Vendas por opçãoGET/v1/orders/summary/optionsorders:read
Criar pedidoPOST/v1/ordersorders:write
Atualizar status de entregaPATCH/v1/orders/{orderId}/delivery-statusorders:write
Cancelar pedidoPOST/v1/orders/{orderId}/cancelorders:write

Clientes — customers:read

PáginaRotaEscopo
Listar clientesGET/v1/customerscustomers:read
Detalhe do clienteGET/v1/customers/{customerId}customers:read

Cupons — coupons:read / coupons:write

PáginaRotaEscopo
Listar cuponsGET/v1/store/couponscoupons:read
Detalhe do cupomGET/v1/store/coupons/{couponId}coupons:read
Criar cupomPOST/v1/store/couponscoupons:write
Atualizar cupomPATCH/v1/store/coupons/{couponId}coupons:write

Avaliações — reviews:read

PáginaRotaEscopo
Listar avaliaçõesGET/v1/store/reviewsreviews:read

Catálogo · Setores — catalog:read / catalog:write

PáginaRotaEscopo
Listar setoresGET/v1/catalog/sectorscatalog:read
Detalhe do setorGET/v1/catalog/sectors/{sectorId}catalog:read
Criar setorPOST/v1/catalog/sectorscatalog:write
Atualizar setorPATCH/v1/catalog/sectors/{sectorId}catalog:write
Atualizar cardápios do setorPATCH/v1/catalog/sectors/{sectorId}/menuscatalog:write
Atualizar setores em lotePATCH/v1/catalog/sectorscatalog:write
Excluir setorDELETE/v1/catalog/sectors/{sectorId}catalog:write

Catálogo · Produtos — catalog:read / catalog:write

PáginaRotaEscopo
Listar produtosGET/v1/catalog/productscatalog:read
Detalhe do produtoGET/v1/catalog/products/{productId}catalog:read
Criar produtoPOST/v1/catalog/productscatalog:write
Atualizar produtoPATCH/v1/catalog/products/{productId}catalog:write
Atualizar produtos em lotePATCH/v1/catalog/productscatalog:write
Atualizar cardápios do produtoPATCH/v1/catalog/products/{productId}/menuscatalog:write
Atualizar restrições do produtoPATCH/v1/catalog/products/{productId}/restrictionscatalog:write
Ordenar grupos do produtoPATCH/v1/catalog/products/{productId}/groupscatalog:write
Excluir produtoDELETE/v1/catalog/products/{productId}catalog:write

Catálogo · Complementos — catalog:read / catalog:write

PáginaRotaEscopo
Listar complementosGET/v1/catalog/complementscatalog:read
Detalhe do complementoGET/v1/catalog/complements/{complementId}catalog:read
Criar complementoPOST/v1/catalog/complementscatalog:write
Atualizar complementos em lotePATCH/v1/catalog/complementscatalog:write
Atualizar complementoPATCH/v1/catalog/complements/{complementId}catalog:write
Atualizar cardápios do complementoPATCH/v1/catalog/complements/{complementId}/menuscatalog:write
Excluir complementoDELETE/v1/catalog/complements/{complementId}catalog:write

Catálogo · Grupo de opções — catalog:read / catalog:write

PáginaRotaEscopo
Listar gruposGET/v1/catalog/groupscatalog:read
Detalhe do grupoGET/v1/catalog/groups/{groupId}catalog:read
Criar grupoPOST/v1/catalog/groupscatalog:write
Atualizar grupoPATCH/v1/catalog/groups/{groupId}catalog:write
Excluir grupoDELETE/v1/catalog/groups/{groupId}catalog:write
Vincular produtos ao grupoPOST/v1/catalog/groups/{groupId}/productscatalog:write
Desvincular produto do grupoDELETE/v1/catalog/groups/{groupId}/products/{productId}catalog:write

Catálogo · Opções — catalog:read / catalog:write

PáginaRotaEscopo
Listar opçõesGET/v1/catalog/optionscatalog:read
Vincular opção ao grupoPOST/v1/catalog/groups/{groupId}/optionscatalog:write
Editar opções em lotePATCH/v1/catalog/optionscatalog:write
Remover opção do grupoDELETE/v1/catalog/groups/{groupId}/options/{optionId}catalog:write

Catálogo · Imagens — catalog:write

PáginaRotaEscopo
Enviar imagemPUT/v1/catalog/{resourceType}/{resourceId}/imagecatalog:write
Remover imagemDELETE/v1/catalog/{resourceType}/{resourceId}/imagecatalog:write