Histórico da Página
...
Escopo
- Enviar ao cliente final um email e-mail ou mensagem com um link, que quando for acessado, exibirá informações sobre o pedido, assim como o status atual de sua entrega.
Layout de requisição para criação de company
Requisição para criar uma company | |||||
---|---|---|---|---|---|
Path: http://10.172.215.57:8087/public-client-view/public-client-view/company/save Método: POST Obs: Ao salvar uma company, é gerada uma key que deverá ser enviada como header nas requisições de client view. | |||||
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações |
identifier | String | Sim | 255 | Identificador da companhia. | Deve ser único. |
String | Não | 255 | Email para o cliente entrar em contato com a companhia, se cadastrado aparecerá no rodapé do email e no site. | Texto livre. | |
phone | String | Não | 255 | Telefone para o cliente entrar em contato com a companhia, se cadastrado aparecerá no rodapé do email e no site. | Texto livre. |
cnpj | String | Sim | 255 | CNPJ da companhia. | Deve ser um CNPJ válido, e só pode estar atrelado a uma única companhia. |
Exemplo JSON criação de company
{ } |
Layout de requisição para criação de companyUser
Requisição para criar user | |||||
---|---|---|---|---|---|
Path: http://10.172.215.57:8087/public-client-view/public-client-view/user/save Método: POST | |||||
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações |
String | Sim | 255 | Email do usuário. | Texto Livre. | |
password | String | Sim | 255 | Senha do usuário. | Deve ter 6 ou mais caracteres, ser composta de letras e números, e ter pelo menos uma letra maiúscula e uma minúscula. |
company | RestCompany | Sim | Companhia na qual o usuário será cadastrado. | Se a companhia existe na base de dados. |
Exemplo JSON criação de companyUser
{ |
Layout de requisição para criação de companyConfig
Requisição para criar companyConfig | |||||
---|---|---|---|---|---|
Path: http://10.172.215.57:8087/public-client-view/public-client-view/companyConfig/save Método: POST Header: token: userToken | |||||
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações |
emailUsername | String | Sim | 255 | Email do usuário. | Texto livre. |
emailPassword | String | Sim | 255 | Senha do usuário. | Texto livre. |
emailHostSmtp | String | Sim | 255 | Servidor SMTP. | Texto livre. |
emailPort | String | Sim | 255 | Porta. | Texto livre. |
emailSenderAddress | String | Sim | 255 | Remetente. | Texto livre. |
emailSsl | boolean | Sim | Criptografia SSL. | Não pode ser nulo. | |
emailTls | boolean | Sim | Criptografia TLS. | Não pode ser nulo. | |
logo | byte[] | Não | Logo da empresa que pode estar no cabeçalho do email. | Formatos aceitos: jpeg / png. |
Exemplo JSON criação de companyConfig02
{ |
Layout de requisição para criação de clientView
Requisição para criação de clientView | ||||||
---|---|---|---|---|---|---|
Path: http://10.172.215.57:8087/public-client-view/public-client-view/create Método: POST Header: key: companyKey | ||||||
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
restClientViews | RestClientView[] | Sim | Lista de RestClientView. | Todos os campos possuem validações próprias. |
Exemplo |
| ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos | ||||||
orderCode | String | Sim | 255 | Código do pedido. | Deve ser único. | ExemplosExemplo | ||||||
orderItens | StringRestClientViewOrderItem[] | Sim255 para cada item | Lista de itens do pedido. | Texto LivreRestClientViewOrderItem váido. | ExemplosExemplo | |||||||
origin | RestClientViewLocation | Sim | Localidade de origem. | RestClientViewLocation válido. | Exemplo | |||||||
destination | RestClientViewLocation | Sim | Localidade de destino | e destino do pedido. | RestClientViewLocation válido. | ExemplosExemplo | ||||||
status | String | Sim | Status atual do pedido. | PREPARING_TO_SHIP, ON_THE_WAY, DELIVERED. | Exemplo | |||||||
contact | RestClientViewContact | Sim | Dados de contato do cliente. | RestClientViewContact válido. | ExemplosExemplo | |||||||
estimatedTimestamp | DateTime | Sim | Data estimada de entrega. | Formato ISO8601. | Exemplos
RestClientViewLocation
| ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
name | String | Sim | 255 |
Nome. | Texto Livre. |
Exemplo |
address | String | Sim | 255 |
Endereço. | Texto Livre. |
Exemplo |
RestClientViewContact
| ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos | ||||||
name | String | Não | 255 | Nome do Contato. | Texto Livre | Exemplo | ||||||
String | Sim, caso não seja enviado o telefone. | 255 | Email de contato. | Formato: [email protected] | ExemplosExemplo | |||||||
phone | String | Sim, caso não seja enviado o email. | Telefone de contato. | Formato: (xx)xxxxx-xxxx | ExemplosTexto Livre. | Exemplo |
RestClientViewOrderItem
| ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos | ||||||
code | String | Sim | 255 | Código do item. | Texto Livre. | Exemplo | ||||||
product | String | Sim | 255 | Nome do produto. | Texto Livre. | Exemplo | ||||||
quantity | Integer | Sim | Quantidade. | Exemplo |
Exemplo de requisição JSON
exemplosJson { "orderCode": "pedidoExemploCódigo", "orderItens": [ "ItemExemplo" ], "location": { "origincode": "origemExemplo1223/codigo", "destinationproduct": "destinoExemploMilho verde", "contactsquantity": [2 } ], "origin": { "name": "Origem", "emailaddress": "noreply@totvs.com.br"Endereço Origem" }, "destination": { "name": "Destino", "phoneaddress": "(xx)xxxxx-xxxxEndereço Destino" }, "status": "PREPARING_TO_SHIP", }"contact": { ] }, "name": "Nome", "email": "email@exemplo.com", "statusphone": "PREPARING_TO_SHIP"(99)9999-9999" }, "estimatedTimestamp": "2022-0509-16T1710T16:1214:3900,909000" } ] |
Layout de Resposta
RestClientViewResponse | |||
---|---|---|---|
Campo | Tipo | Descrição | |
successMessage | RestClientMessage | Mensagem de criação com sucesso. | |
restClientViewMessage[] | RestClientViewMessage[] | Lista de mensagens com | os erros na criaçãoresultado da requisição. |
RestClientViewMessage
| ||||||||
---|---|---|---|---|---|---|---|---|
Campo | Tipo | Descrição | ||||||
messageCode | String | Código da mensagem. | ||||||
message | String | Mensagem. |
Layout de requisição para atualização de status
Path: http://10.172.215.57:8087/public-client-view/public-client-view/update/status/on-the-way/ Método: POST |
---|
Tipo | Obrigatório | Descrição | Validações |
---|
Exemplos | |||
---|---|---|---|
String[] | Sim | Atualiza o status para a caminho ( ON_THE_WAY ). | Valida se |
os pedidos existem. | ExemploUpdate |
Path: http://10.172.215.57:8087/public-client-view/public-client-view/update/status/finish/ Método: POST | ||||||||
---|---|---|---|---|---|---|---|---|
Parâmetro | Key | Tipo | Obrigatório | Descrição | Validações | Retorno | Código do pedido | orderCode|
String[] | Sim | Atualiza o status para entregue ( DELIVERED ). | Valida se o pedido existeos pedidos existem. | vazioExemploUpdate |
Exemplo de requisição JSON para update
[ "CódigoPedido2" |
Catálogo de mensagens
Pivot Table | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Diagrama de Banco |