Neste post, vamos explicar quais são os primeiros passos para começar a utilizar essa API e posteriormente o fluxo principal para utilizar o PlugStorage.
Neste artigo você encontra o como:
- Criando a conta de parceiro
- Personalizando o PlugStorage
- Cadastrando o Cliente
- Personalizando o Cliente
- Configurando certificado digital para busca de destinadas e manifesto de notas
- Vinculando o contador do cliente
- Integrando via API
- Montando uma Requisição
1º Passo - Criando a conta de parceiro
Para realizar seu cadastro como parceiro no Plug Storage você precisa criar a sua conta em nossa página de login e clicar em CRIAR UMA CONTA.
E preencher as informações solicitadas.
Após finalizar o cadastro, é necessário acessar e-mail que foi informado e ativar a conta, basta clicar no link que foi enviado para o e-mail.
Observação: Se estiver utilizando uma conta trial, lembre-se de que após o período de 30 dias, o acesso à sua conta será desativado, assim como o acesso dos clientes vinculados à Software House. Consequentemente, ao tentar acessar o painel do parceiro ou cliente, serão exibidas as seguintes mensagens:
Token de Integração
Feito isso, você poderá realizar o login em seu usuário. Umas das principais informações que você deve verificar é o Token de integração, ele será usado para autenticar todos os envios de notas para o Plug Storage.
Para visualiza-lo você deve ir em: Configurações > Dados da Conta e verificar o campo Token de Integração.
2º Passo - Personalizando o PlugStorage
No Plug Storage, existem diversas configurações, algumas delas estão diretamente relacionadas ao visual e configurações de e-mail como o White Label e as configurações de SMTP. Com essas configurações você pode deixar o PlugStorage com a cara da sua empresa e passar ao seu cliente a sensação de não sair do seu meio.
White Label
Com o White Label da TecnoSpeed é possível alterar o link de acesso dos seus clientes além de alterar as logos que são utilizadas, tanto nas páginas quanto nos e-mail's. Em nosso post sobre as configurações da Software House existem mais detalhes de como fazer essas configurações.
Servidor SMTP
Com as configurações do Servidor SMTP seu cliente irá receber os e-mail's do PlugStorage como se você estivesse enviando, para isso basta realizar a configuração do seu e-mail em nossa Interface e pronto, todos os e-mail enviados terão como emitente o e-mail configurado. Em nosso post sobre as configurações da Software House existem mais detalhes de como fazer essas configurações.
3º Passo - Cadastrando o Cliente
Para começar o envio de XML's para o Plug Storage e para que seu cliente tenha acesso a eles posteriormente, é necessário realizar o cadastro dos seus clientes no painel do Plug Storage. Após o cadastro, o cliente também terá acesso a uma interface Web, onde pode realizar algumas configurações e personalizações da sua conta.
Existem duas forma de realizar esse cadastro. Através da nossa interface Web ou através de nossa API.
Cadastrando por painel
Para realizar o cadastro pelo nosso painel, você precisa acessar a aba do Cliente e clicar em Novo Cliente. Após isso será mostrada a tela abaixo:
Basta preencher as informações solicitadas. A opção de permitir acesso caso encerrado se refere a um fim de contrato do cliente, onde o mesmo ainda poderá acessar a interface para ver as notas, mas não poderá mais enviar nenhuma nota.
Quanto a opção de confirmação de e-mail, caso esteja marcada, será enviado um e-mail para o endereço cadastro para confirmar a criação da conta bem como a criação de uma senha.
Cadastrando por API
Também é possível cadastrar o cliente via API, onde você irá utilizar uma requisição do tipo Post para enviar todas as informações necessárias para nós. É possível verificar mais detalhes dessa requisição em nossa documentação sobre o cadastro de cliente por API.
4º Passo - Personalizando o Cliente
Na interface Web do cliente ele pode realizar algumas personalizações, que permitem alterar a logo das impressões da DANFE e da DANFCE além de poder, alterar os e-mail enviados aos clientes e contadores. Para acessar ambas as configurações, é necessário clicar em Configurações > Gerais.
Personalizar DANFE
Tanto para a DANFE quanto para a DANFCE existe um tamanho recomendado da logo, o qual está explicito no portal, basta incluir a nova logo através da opção disponibilizada que será possível ver as impressões das notas com o novo logotipo.
Configurar envio de e-mail
Nas configurações de envio de e-mail é possível escolher o template utilizado no e-mail para informar o recebimento de notas e eventos pelo nota segura, também é possível escolher se esse e-mail será enviado automaticamente ao destinatário da nota ou não.
Existem algumas variáveis nesse ambiente que pode ser utilizadas com informações da nota e/ou evento recebido pelo Plug Storage.
5º Passo - Configurando certificado digital para busca de destinadas e manifesto de notas
No Plug Storage é possível realizar o cadastro de um certificado do tipo A1, para que o mesmo possa ser utilizado na busca das notas destinadas, do modelo NFe e CTe, e também para manifesto de notas.
Para isso você deve acessar a opção Configurações > Destinadas - DFe (No portal do cliente) ou em Clientes > Configurações DFe (No portal do parceiro), após isso, basta preencher os dados solicitados.
A verificação automática é utilizada para constantemente fazer a consulta das destinadas na receita de acordo com o tempo escolhido na opção, dessa forma, o cliente irá receber e-mail's informando que as destinadas foram consultadas, caso o cliente não queira receber notificação por e-mail, é necessário desmarcar a opção de permitir notificação por e-mail.
O Tipos de Documentos é utilizado para especificar quais documentos devem ser buscados no sefaz, podendo selecionar NFe, CTe ou Ambos.
6º Passo - Vinculando o contador do cliente
Pensando em facilitar a transferência de dados entre clientes e contador é possível vincular um e-mail de contador no cliente Configurações > Contador (no painel do cliente), Clientes > Vincular Contador (no painel do parceiro), para isso basta cadastrar o e-mail do contador, como na imagem:
É possível também escolher a forma de envio das notas para o contador. Existem dois tipos de envio, o Singular, Recorrente e Não enviar e-mail.
No envio singular, uma vez por mês, na data que você selecionar será enviado para o contador todos os XML's do mês anterior.
No envio recorrente, você escolhe a cada quantos dias você deseja que o e-mail seja enviado.
7º Passo - Integrando via API
Todos os exemplos da utilização da API foram produzidos e testados através do Postman, uma ferramente que permite realizar requisições de uma forma mais visível, facilitando assim o entendimento das rotinas.
Instalar o Postman
O Postman pode ser baixado e instalado como uma aplicação desktop ou adicionado como uma aplicação do Google Chrome.
Importar a coleção de requisições
Após abrir o aplicativo, para importar uma coleção de requisições, basta clicar no botão "Import", no canto esquerdo da barra superior.
Em anexo, temos um arquivo com as rotas disponíveis.
Converter a requisição em código
O Postman possui uma funcionalidade que permite visualizar uma requisição em algumas linguagens. Com a requisição aberta, basta clicar no botão "Code", no canto direito da tela, conforme é mostrado na imagem abaixo.
Após isso, será aberta uma janela com um trecho de código correspondente àquela requisição. Para alterar a linguagem, basta clicar na seta apontada para baixo, no canto superior esquerdo da janela, e selecionar a linguagem desejada.
8º Passo - Montando uma Requisição
Na API do Plug Storage, vamos utilizar 3 tipos de requisições, as do tipo POST, as do tipo GET e as do tipo PUT.
As requisições do tipo POST servem, nesse caso, para o envio das informações para nossa api, para que possamos realizar os tratamentos necessários e inclusão de notas, clientes, contadores e etc.
As requisições do tipo GET servem, nesse caso, para a consulta de informações, que no nosso caso será referente as notas e manifestos.]
Já as requisições do tipo PUT servem, nesse caso, para a alteração de registros já existentes em nossa base, como a alteração dos dados de um usuário já cadastrado.
Montando a URL
A URL sempre será no padrão UrlRaiz + rota + parâmetros, sem contar com o cabeçalho da requisição (Headers) e o Body (quando necessário).
A URL raiz do Plug Storage é: https://app.plugstorage.com.br/api/ e as rotas são:
- invoices
- users (post)
- /users/resendactivation
- clients/updateemail
- users (put)
- manifests (post)
- manifests (get)
- invoices/export
- users/linkaccountant
Cada rota tem suas especificidades entre parâmetros, body e headers.
Comentários
0 comentário
Por favor, entre para comentar.