A integração de vales desenvolvida especificamente para uma rede de franquias, possibilita a criação e exclusão de um vale diretamente na base central da franqueadora para que o mesmo possa ser consumido posteriormente para geração de um vale compras na franquia, Esta integração está disponibilizada em uma API Publica (Padrão REST) validado no sistema Microvix.
Dica
O endereço para integração você pode acessar clicando aqui.
A página de desenvolvimento desta customização pode ser acessada clicando aqui.
Autenticação Guid no header da requisição
| Campo | Descrição | Tipagem |
|---|---|---|
| IntegrationAutentication | É a chave de integração usada no projeto do WebService de BD, essa chave é gerada pelo time de BD, para que os clientes possam utilizar o WebService, foi feito a mesma autenticação. Chave adquirida após contratação ta integração. | string |
Importante!
Deve ser utilizado para todos os métodos.
Inserir Vale Troca na Rede – Requisição POST
Atenção!
Link de método clicando aqui.
- Parâmetros de entrada - Body tipo JSON
| Nome Campo | Descrição | Tipagem | Obrigatório |
|---|---|---|---|
| NumeroControle | Código do vale gerado pelo próprio cliente | Int | Sim |
| DocumentoCliente | CPF do cliente que vai ficar vinculada (utilizar) o vale | String | Sim |
| Valor | Valor/saldo do vale para o cliente utilizar | Decimal | Sim |
| CnpjEmpresa | CNPJ da empresa que está gerando o vale | String | Sim |
| Usuario | Código do usuário no Microvix que ficara vinculado ao log de inserção do vale | Int | Sim |
Excluir Vale Troca na Rede – Requisição POST
Atenção!
Link de método clicando aqui.
- Parâmetros de Saída - JSON
| Nome Campo | Descrição | Tipagem | Obrigatório |
|---|---|---|---|
| NumeroControle | Código do vale gerado pelo prórpio cliente | Int | Sim |
| DocumentoCliente | CPF do cliente que vai ficar vinculada (utilizar) o vale | String | Sim |
| CnpjEmpresa | CNPJ da empresa que está gerando o vale | String | Sim |
| Usuario | Código do usuário no Microvix que ficara vinculado ao log de inserção do vale | Int | Sim |