A plataforma conta hoje com uma API (trata-se de uma forma de comunicação entre sistemas) mais básica, mas que já permite algumas integrações.

A plataforma se integra com outros sistemas?

Não. É importante destacar que o Ideia no Ar não realiza integração com outros sistemas além dos que já vêm integrados na plataforma: Melhor Envio, Pagar.me e Wirecard (gateways de pagamento), Facebook (para cadastro e login facilitados) e Sendgrid (Gerencia de e-mails automáticos da plataforma).

Mas outros sistemas podem se integrar à plataforma.

Como eu posso fazer uma integração com a plataforma?

Você precisar ter conhecimentos de programação, ou precisa contratar alguém que os tenha e possa desenvolver a integração por você. Reforçando: o Ideia no Ar não faz esse tipo de trabalho.

Para ajudá-lo, estruturamos um canal de parceiros, para que você possa encontrar profissionais capacitados para contratar e realizar este tipo de trabalho.

Acesse
http://bit.ly/parceiros-de-tecnologia-ideianoar

Além disso, você também pode encontrar freelancers capacitados para desenvolver a sua integração. O mais interessante é que não existe um pré-requisito de linguagem que o desenvolvedor precisa conhecer para conseguir desenvolver uma integração de API. Qualquer linguagem moderna serve, mas as mais comuns atualmente são: Node JS, C# (lê-se "C-sharp"), PHP, Java, Ruby e Python.

Para encontrar um desenvolvedor freelancer, qualquer plataforma de recrutamento online serve. Mas, para referência, indicamos o Workana, que é uma plataforma com alta disponibilidade de profissionais selecionados. Acaba sendo um lugar onde você encontra gente boa com preço bom, na faixa de 40-50 reais por hora.

Plataforma de freelancers
https://www.workana.com/?locale=pt_BR

Como funciona a integração da plataforma

Toda integração entre sistemas acontece através de uma API. Quando um sistema tem uma API, é como se ele tivesse um ouvido e uma boca, para "escutar" o que outros sistemas falam com ele, e para "falar" em resposta a estes outros sistemas.

A característica de uma API é ser reativa ao invés de pró-ativa. Ou seja, a plataforma tem a API, mas esta API não faz nada até que um sistema venha "falar" com ela.

Quais integrações são possíveis?

Atualmente, as integrações possíveis são:

  • Vendedores: listar
  • Produtos/Serviços: atualizar alguns dados
  • Pedidos: listar, obter os detalhes de um pedido, atualizar o status de um pedido
  • Agenda do vendedor: criar bloqueios, detalhar um bloqueio

Notificações entre sistemas

A plataforma também conta com um mecanismo de notificações entre sistemas, conhecido pelos técnicos da área como webhooks. Com este sistema de notificações, a plataforma pode avisar outros sistemas integrados com a plataforma sobre coisas que ocorreram na plataforma. Exemplos:

  • Quando um pedido foi realizado
  • Quando uma locação foi realizada
  • Quando um pedido mudou de status (ex. foi pago, foi enviado, foi cancelado)

É como se a plataforma entrasse em contato com um outro sistema para dizer "Ei, fizeram um novo pedido aqui, e o código dele é 123. Fale comigo se quiser saber mais." A partir disso, o outro sistema pode usar a API para consultar os detalhes do pedido 123 a qualquer momento.

O que você precisa repassar para um desenvolvedor

Se você precisa explicar para algum programador ou parceiro de tecnologia como funciona a integração com a plataforma, você pode passar à ele este mesmo artigo que você está lendo agora.

Aqui ele tem acesso a este link abaixo, que traz a documentação técnica da plataforma, explicando questões de segurança, como integrar, e muito mais.

Documentação da API
http://bit.ly/ina-marketplace-api-v1-docs

Perguntas frequentes

  • A plataforma disponibiliza alguma API mais completa que esta documentada no primeiro link?
    R: Não, esta é a única API disponibilizada pela plataforma
  • Mas vocês não podem disponibilizar a mesma API usada pelo front-end da plataforma?
    R: O front-end da plataforma não usa APIs para funcionar; o front-end é feito em cshtml; o frontend é gerado e renderizado pelo backend.
  • Vocês farão o desenvolvimento da API conforme a nossa necessidade?
    R: Como explicado no artigo do da base de conhecimento (segundo link acima), o Ideia no Ar não faz o desenvolvimento customizado. Porém disponibilizamos o plano Startup para os negócios que quiserem obter o código fonte e realizar os desenvolvimentos necessários para adaptar melhor a plataforma ao seu próprio negócio.
  • A plataforma de vocês se integra ao meu sistema?
    R: Não. A plataforma disponibiliza a API, mas esta API não faz nada até que um sistema venha "falar" com ela. Ou seja, você deverá fazer um desenvolvimento no sistema que deseja integrar à plataforma. Se não tiver possibilidade de alterar o código fonte do sistema que deseja integrar à plataforma (as vezes é o caso em alguns ERPs), você pode fazer o desenvolvimento de um sistema intermediário, que fará a comunicação proativa entre a plataforma e o sistema que deseja integrar.
  • Quais dimensões, tamanhos e formatos aceitos no upload de imagens?

           R: Veja neste artigo.

  • Quais integrações são possíveis?
    R: Atualmente, as seguintes integrações são possíveis:Vendedores: listarProdutos/Serviços: atualizar alguns dadosPedidos: listar, obter os detalhes de um pedido, atualizar o status de um pedidoAgenda do vendedor: criar bloqueios, detalhar um bloqueio
  • Como é o fluxo de informações da API?
    R: A API da plataforma segue o padrão REST, trafegando dados em formato JSON. Seu sistema chama a API da plataforma para Ler, Criar e Editar recursos (Vendedores, Produtos, Serviços, Pedidos e Agenda do Vendedor). A plataforma responde conforme a requisição em questão. A plataforma também conta com o mecanismo de Webhooks, já bem conhecido no mundo das integrações, para notificar seu sistema sobre avanço de status de pedidos e agendamentos.
  • Qual é a tecnologia da plataforma?
    R: Em resumo: C#, AspNet MVC 5, banco de dados SQL Server, hospedagem AWS. As especificações técnicas completas da plataforma podem ser consultadas neste link: https://share.nuclino.com/p/Especificaes-tcnicas-_V0nR5QBDv2VZkt_FGiqYH
  • Como gerar tokens de API na plataforma?
    R: Para gerar um token, basta acessar o Painel Administrativo > configurações > tokens:

E gerar um dessa forma:


É possível especificar um vendedor pra que a API faça um limite automático dos dados que a integração consegue acessar. Se não filtrar por um vendedor (como no exemplo acima), a integração poderá ler/controlar dados de todos os vendedores. Se filtrar, poderá ler/controlar dados apenas do vendedor especificado.

Ao salvar, aparece assim:

Então agora é preciso copiar apenas esse token para usar na integração que vai ser desenvolvida, e aí é só passar para o programador. Para ajudar o programador, segue documentação da API: http://bit.ly/ina-marketplace-api-v1-docs

Conforme esta documentação, o endpoint é sempre a própria plataforma:

Caso alguma dúvida não tenha sido suprida nesse artigo entre em contato conosco via e-mail, no endereço: suporte@ideianoar.com.br.