Nossas Integrações

A integração com a Tray é feita através das Nossas APIs no padrão REST, o que possibilita manipular os clientes, produtos e até os pedidos da loja virtual. Atualmente estão disponíveis as APIs:

api.png

  • Carrinho de Compra
  • Categorias
  • Clientes
  • Frete
  • Informações da Loja
  • Newsletter
  • Pagamentos
  • Páginas da Loja
  • Palavras-Chave
  • Parceiros
  • Pedidos
  • Produtos
  • Scripts Externos

Para utilizar as APIs é necessário criar seu aplicativo e, após este cadastro, são liberadas as chaves para a integração.

Temos disponível para parceiros nossa Loja de Aplicativos, onde nossos lojistas conseguem localizar e fazer a instalação de forma simples e rápida e já integrar com a sua aplicação.

Desta forma, é possível integrar desde um sistema de gestão empresarial (ERP) ou sistemas próprios para melhorar a experiência do consumidor.

Também disponibilizamos a integração com o sistema de Gateway de Frete, caso precise personalizar o calculo de frete através de alguma transportadora.

 

Criando seu Aplicativo

Para disponibilizar as chaves de integração é necessário realizar dois processos:

  • Realizar o credenciamento
  • Informar os dados para a criação de uma aplicação.

Para o credenciamento é necessário contato com nossa equipe de parcerias através do formulário de contato.

Após o credenciamento, será necessário informar os dados do aplicativo para cadastro. Estes dados são divididos em dados do integrador, onde é necessário informar os dados da empresa que irá realizar a integração, e dados do aplicativo, com os dados para cadastro da aplicação. Segue abaixo os dados necessários:

Dados do Aplicativo:

  • Nome do aplicativo
  • Descrição simplificada do aplicativo
  • Imagem com o logo da aplicação
  • Descrição completa do aplicativo
  • Link do vídeo (Youtube)
  • URL de callback, em ambiente seguro - SSL (URL utilizada para realizar a autorização da aplicação)
  • URLs de imagens (máximo 3)

Dados do integrador:

  • Nome da empresa
  • Telefone
  • E-mail
  • Site
  • Nome do Responsável Técnico (Desenvolvedor)
  • E-mail do Responsável Técnico (Desenvolvedor)

Após o cadastro da aplicação são disponibilizadas as chaves Consumer Key e Consumer Secret necessárias para a autorização do aplicativo e geração das chaves de acesso.

OBS: Todas as solicitações serão analisadas, onde poderão ser aprovadas ou rejeitadas devido solicitação indevida, ausência de informações ou solicitação de parceiro ou desenvolvedor não credenciado.

Quantidade de Requisições

As requisições tem um limite de envio, onde são diferenciadas de duas formas.

1 - Quantidade de requisições de curto espaço de tempo, limitado em 180 requisições por minuto.

2 - Quantidade de requisições diárias, limitado em 10 mil requisições diárias por loja, sendo um limite de 50 mil requisições por dia em caso de loja corporativa.

Autorizando seu Aplicativo

A autenticação via oAuth 2.0 é necessário para acesso as informações da API e Aplicativos de Terceiro.

Abaixo a sequência de autenticação:

fluxo_auth.png

O código de autorização é fornecido através do servidor de autenticação do Tray.

Para permitir acesso as informações e recursos da conta, o cliente deve ser redirecionado para a url de autenticação pelo navegador.

O Tray Commerce é responsável por receber a confirmação da autorização do cliente e fornecer o código de autorização ao aplicativo.

Url para autenticação:

https://{dominio_da_loja}/auth.php

Parâmetros HTTP "GET" suportados para a autenticação:

Parâmetro Descrição
response_type Tipo de solicitação (Valor padrão code)
consumer_key Identificação do aplicativo junto ao Tray Commerce.
callback URL de Callback que será redirecionado depois da autorização

Exemplo da url:

https://{dominio_da_loja}/auth.php?response_type=code&consumer_key=2r9dg7sgdb&callback=https://{url_de_callback}

 

Fluxo de autorização

Toda aplicação precisa passar pelo processo de autorização, onde sem essa autorização, não é possível acessar os dados da loja, senão qualquer pessoa com as chaves poderiam acessar qualquer loja de nossa plataforma sem o conhecimento do lojista, o que seria uma grande falha de segurança.

O aplicativo é acessado dentro da área administrativa da loja no menu Meus aplicativos. Após o acesso a este menu, terá disponível o botão Instalar novos aplicativos, onde os clientes poderão localizar a aplicação para instalação na loja.

Ao instalar uma aplicação, será realizado o redirecionamento para a URL de Callback informada no momento do cadastro do aplicativo, abrindo por exemplo a página http://{dominiodoapp}/tray/callback em um iframe, dentro da área administrativa da loja.

Você deverá implementar nesta URL (http://{dominiodoapp}/tray/callback), uma Landing Page apresentando os detalhes do aplicativo e disponibilizar um botão para o cliente solicitando a integração com a aplicação. Geralmente este botão tem o titulo de Instale agora ou Inicie agora.

Neste botão você irá direcionar o cliente para a URL de autorização da loja, onde esta URL ficaria:

http://{URL da loja}/auth.php?response_type=code&consumer_key=**CONSUMER_KEY**&callback=http://{dominiodoapp}/tray/callback/auth/

Quando direcionado o cliente para essa pagina, irá aparecer uma tela solicitando a autorização da aplicação, conforme abaixo:

tela_auth.png

Uma observação importante é que, após autorizado, não será mais exibida essa tela, já passando automaticamente para o fluxo abaixo.

Após a autorização, o cliente é redirecionado para URL informada no parâmetro callback passado no momento da autorização (no exemplo acima é a URL http://{dominiodoapp}/tray/callback/auth/), onde ficará da seguinte forma esta URL:

http://{dominiodoapp}/tray/callback/auth/?code=2132112312321313abc123edf&store=391250&api_address=http://{URL da loja}/web_api/

Neste processo deve-se capturar as informações dessa URL e utilizá-las para configurar em sua aplicação, sendo os parâmetros code e api_address mais importantes no processo de integração.

Com o code e api_address é possível utilizar a [API de Gerar Chave de Acesso](http://developers.tray.com.br/commerce/#api-Auth-PostAuth), para gerar o valor do access_tokenutilizados nas outras APIs. É de extrema importância armazenar todas as informações de retorno desta API, pois serão utilizados constantemente durante a comunicação com a Tray.

Pode-se notar que no retorno da [API de Gerar Chave de Acesso](http://developers.tray.com.br/commerce/#api-Auth-PostAuth) existe a expiração dessa chave e, quando expirado, deverá utilizar a [API de Atualizar Chave de Acesso](http://developers.tray.com.br/commerce/#api-Auth-GetAuth), onde será gerada um novo access_token para continuar realizando requisições nas APIs.

Dessa forma, toda referência que encontrar na documentação de {api_address} deverá ser utilizada a URL retornada no momento da autorização da API, conforme informado acima, e utilizar o access_token gerado para não ocorrer problema de permissão de acesso aos dados.

 
Frontend - Agencia 
Tem mais dúvidas? Envie uma solicitação

Comentários

    Artigos nessa seção

    Powered by Zendesk