Algumas entidades virtuais podem ser criadas para registrar dados através da loja. Os dados podem ser manipulados através de endpoints que podem ser disparados via AJAX. São eles:
Inserção de dados para múltiplos formulários
[POST] /ecommerce/ve/{slug}/records
Onde:
{slug}
é o slug da entidade virtual a ser manipulada.
E o seguinte formato deve ser respeitado para envio dos dados:
{
form1: {
slug1: 'valor',
slug2: 1
},
form2: {
slug3: 'valor'
}
}
Onde:
- {form} deve ser um inteiro válido e existente, indicando de qual formulário pertence os campos extras.
- {slug} deve ser um texto, indicando qual o campo extra do valor a ser informado a seguir.
- os valores devem ser compatíveis ao tipo do campo extra cadastrado indicado através do slug.
Inserção de dados para um formulário específico
[POST] /ecommerce/ve/{slug}/records/{form}
Onde:
{slug}
é o slug da entidade virtual a ser manipulada.{form}
é o id do formulário cujos dados serão preenchidos.
O formato para envio dos dados é semelhante ao envio sem o formulário informado de forma explícita, devendo suprimir o índice do formulário. Algo como:
{
slug1: 'valor',
slug2: 1,
slug3: 'valor'
}
Onde:
- {slug} deve ser um texto, indicando qual o campo extra do valor a ser informado a seguir.
- os valores devem ser compatíveis ao tipo do campo extra cadastrado indicado através do slug.
Carregar registros de entidade virtual
[GET] /ecommerce/ve/{slug}/records
Onde:
{slug}
é o slug da entidade virtual a ser manipulada.
O formato de retorno dos dados é separado entre slug e valor. Algo como:
{
slug1: 'valor',
slug2: 1,
slug3: 'valor'
}
Atualização de dados para múltiplos formulários
[PUT] /ecommerce/ve/{slug}/records/{id}
Onde:
{slug}
é o slug da entidade virtual a ser manipulada.{id}
é o id do registro que será editado
O formato de envio é igual à Inserção de dados para múltiplos formulários descrita nesse mesmo artigo.
Atualização de dados para um formulário específico
[PUT] /ecommerce/ve/{slug}/records/{id}/forms/{form}
Onde:
{slug}
é o slug da entidade virtual a ser manipulada.{id}
é o id do registro que será editado{form}
é o id do formulário cujos dados serão preenchidos
O formato de envio é igual à Inserção de dados para um formulário específico descrita nesse mesmo artigo.
Exclusão de registro de entidade virtual
[DELETE] /ecommerce/ve/{slug}/records/{id}
Onde:
{slug}
é o slug da entidade virtual a ser manipulada.{id}
é o id do registro que será editado
Enviando o token de autenticação no cabeçalho da requisição
Em todas as rotas acima, por questões de segurança, é obrigatório que o usuário esteja logado para que as mesmas sejam processadas. Do contrário, o status 401 será retornado pelo servidor.
Por isso, no cabeçalho das requisições a chave Authorization
sempre deverá ser informada com o o token junto do prefixo Bearer
como valor.
Para obter o token do usuário autenticado, o plugin Canopus disponibiliza o método OauthService.getToken()
.
Comentários
0 comentário
Por favor, entre para comentar.