Configuração e Inicialização
Esta seção apresenta os métodos essenciais para a configuração inicial e o ambiente operacional do InvoiCy Framework. Para garantir o funcionamento correto e a conformidade fiscal dos documentos emitidos, é obrigatório utilizar estas funções para definir o diretório de trabalho, o ambiente de emissão e os parâmetros específicos para a Plataforma InvoiCy, SAT e MFE.
InvoiCyFramework_ConfiguraDiretorio
Configura a pasta onde o InvoiCy Framework grava os arquivos adicionais necessários para sua operação (layout específico de impressão de DANFE, arquivo bitmap do logotipo, etc.), os arquivos de log e a pasta de documentos pendentes de sincronização (DocPendentes).
Caso a configuração do diretório não seja realizada, a pasta padrão utilizada pelo Framework no Windows é %PUBLIC%\InvoiCyFW e no Linux é /home/%USER%/InvoiCyFW.
| Sintaxe Windows/Linux | int InvoiCyFramework_ConfiguraDiretorio(char* diretorio); |
| Sintaxe Android | int InvoiCyFramework.ConfiguraDiretorio(String diretorio); |
| Entradas | diretório - nome do diretório de trabalho |
| Saídas | Não possui |
| Retornos | 0 - Erro na execução; 1 - Operação realizada com sucesso |
| Exemplo | int iRet = InvoiCyFramework_ConfiguraDiretorio(“C:\SoftPDV\Dados”); |
InvoiCyFramework_Configura
Configura os parâmetros gerais do InvoiCy Framework.
| Sintaxe Windows/Linux | int InvoiCyFramework_Configura(char* nomeParametro, char* valorParametro); |
| Sintaxe Android | int InvoiCyFramework.Configura(String nomeParametro, StringvalorParametro); |
| Entradas | nomeParametro: nome do parâmetro a ser configurado; valorParametro: valor do parâmetro - A lista com os possíveis parâmetros, pode ser conferida aqui. |
| Saídas | Não possui |
| Retornos | 0 - Erro na execução; 1 - Operação realizada com sucesso |
| Exemplo | int iRet = InvoiCyFramework_Configura(“TEMPO_VERIFICACAO”, “300”); |
InvoiCyFramework_AmbienteEmissao
Configura o tipo de ambiente a ser utilizado, ambiente de homologação ou ambiente de produção. O tipo de ambiente 1 é de produção utilizado para as emissões com valor fiscal em que o fisco utilizará para a apuração dos impostos devidos do CNPJ emissor. O tipo de ambiente 2 é de homologação utilizado para testes de emissão sem valor fiscal.
| Sintaxe Windows/Linux | int InvoiCyFramework_AmbienteEmissao(int tipoAmbiente); |
| Sintaxe Android | int InvoiCyFramework.AmbienteEmissao(int tipoAmbiente); |
| Entradas | tipoAmbiente - tipo de ambiente para emissão: 1-Produção, 2-Homologação (default) |
| Saídas | Não possui |
| Retornos | 0 - Erro na execução; 1 - Operação realizada com sucesso |
| Exemplo | int iRet = InvoiCyFramework_AmbienteEmissao(1); |
InvoiCyFramework_ConfiguraInvoicy
Configura os parâmetros InvoiCy da empresa emissora, chave de parceiro e chave de acesso, necessários para que o InvoiCy Framework possa se comunicar de forma segura com a plataforma InvoiCy.
| Sintaxe Windows/Linux | int InvoiCyFramework_ConfiguraInvoicy(char* cnpj, char* chaveAcesso, char* chaveParceiro); |
| Sintaxe Android | int InvoiCyFramework.ConfiguraInvoicy(String cnpj, StringchaveAcesso, String chaveParceiro); |
| Entradas | cnpj: CNPJ do estabelecimento emissor cadastrado no InvoiCy - somente números, sem formatação; chaveAcesso: Chave de acesso do InvoiCy - está disponível no InvoiCy em: Início > Painel de Controle > Dados da Empresa > Chave de Acesso. Lembrando que esta chave é gerada automaticamente no momento do cadastro da empresa emissora e muda conforme o tipo de ambiente de emissão; chaveParceiro: Chave de parceiro do InvoiCy - está disponível no InvoiCy em: Início > Painel de Controle > Dados da Empresa > Chave de Parceiro. Ela é gerada automaticamente e enviada via e-mail, junto com o usuário parceiro que dá acesso a Plataforma InvoiCy. Esta chave será única e vinculada em todas as empresas emissoras cadastradas pelo usuário parceiro nos ambientes de homologação e produção. |
| Saídas | Não possui |
| Retornos | 0 - Erro na execução; 1 - Operação realizada com sucesso |
| Exemplo | int iRet = InvoiCyFramework_ConfiguraInvoicy (“99999999999999”,“AXxRwGwhuN0m+Pg==”, “eBdz9fcNg9H99Pa9nN”); |