A API da Tray Corp é uma aplicação que fará a integração entre a plataforma da Tray Corp com outra aplicação que seja da sua vontade, como o ERP, por exemplo.

Uma das vantagens desta integração é a padronização.Todos os clientes passam a ter um só meio de integração com a Tray Corp, que é a API.

Uma facilidade nessa personalização é que todos os clientes Tray Corp receberão um atendimento mais ágil e dentro do mesmo ambiente.

Outra vantagem da API é a performance. Atualmente, a Tray Corp utiliza uma formatação de dados para fazer a integração. Essa formatação é mais compacta, mais leve, e com isso melhora na agilidade do processo de integração, faz com que o tráfego de dados se torne mais leve e automaticamente a performance e a agilidade do processo acabam sendo mais rápidos também.

Isso é bom para a plataforma, para a sua funcionalidade e para a comunicação com o seu ERP.

A terceira vantagem é a segurança. Com a API, através da plataforma Tray Corp gera-se multi tokens,para cada aplicação poderá ser gerado um token de acesso e cada token terá um objetivo. O token é baseado em permissionamento. Por exemplo, se você tiver uma aplicação que só permite consultar pedido, então essa aplicação não conseguirá ter acesso a outro métodos de integração que contém na plataforma.

Como utilizar a integração via API?

No link api.fbits.net, você consegue entender um pouco mais sobre o que é a API. Na função como funciona, terão algumas explicações das políticas de acesso.

1.PNG

 E dentro de documentação é onde você encontra como funciona a autenticação com a API.

2.png

A autenticação da API é realizada através da informação do token, assim é verificado a identidade do lojista e validado sua permissão para acessar determinada informação.

Como gerar um token?

Para criar um token, seja para o seu ERP ou outro tipo de ferramenta, você precisará acessar o admin da sua loja. No admin, clicar no menu Configurações Administrativas, token integração. 

3.PNG

Dentro da função token integração, você entrará na opção adicionar token. 

4.PNG

Na tela de edição do token de integração, existem algumas configurações que podem ser feitas, como:

  • Definir o nome da aplicação, para ajudar a identificar quem o token vai servir;
  • Selecionar as permissões que serão liberadas para o token, isso garante que o mesmo só terá acesso a informações que forem autorizadas;
  • Informar o e-mail do responsável técnico.

5.PNG

O token será gerado automaticamente. Logo abaixo, você encontra as opções de permissionamento e então você selecionará quais serão as permissões que esse token poderá ter.

6.PNG

Quando selecionar as permissões, basta salvar e assim aparecerá uma mensagem “token salvo com sucesso”.

E se você voltar em configurações administrativas, token integração, será apresentado o token que você criou.

Então basta você utilizar esse token e passar para a sua equipe de desenvolvimento , e para as pessoas que terão acesso ao suporte do seu ERP para fazerem a comunicação com a plataforma via API.

O processo de criação de token é bem simples e se futuramente houver a necessidade de liberar mais acessos, basta clicar em editar no token e selecionar as demais permissões que o token passará a ter acesso.  

7.png

Para fazer um teste e assim verificar se o token está realmente funcionando, basta copiar o token, clicar em API Explorer, para que seja aberto o campo "api_key" para informar o token e apresente os endpoint´s, e fazer o teste em cima de cada método.

Basta colar o token na caixa, clicar em Try out que fica dentro de cada endpoint e verificar em cada método sua aplicação. 

Esse teste é importante porque se algum momento você tiver algum problema na sua integração, ou alguma dificuldade, você conseguirá perceber se a sua API está funcionando corretamente.

E para melhorar a performance, a Tray Corp controla o número de requisições por minuto que uma aplicação pode ter. Então isso melhora a disponibilidade, não deixa a API ficar lenta e carregada de requisições.

Link para toda a documentação: https://api.fbits.net/

 

Alexsandro Santos 
Tem mais dúvidas? Envie uma solicitação

Comentários

    Artigos nessa seção