Integração Runner

integracaorunner

Integração Automação Fera + Runner
===================

Esse documento tem como objetivo definir os padrões da integração entre a ferramenta de automação de marketing e as aplicações do lado da Runner.

A ferramenta de automação de marketing está hospedada no endereço:
http://automatic.runner.com.br

----------

Endereços
-------------
Base URL:`http://automatic.runner.com.br`
Login: `desenvolvedor`
Senha: `******` (enviaremos via Slack)


#### <i class="icon-provider-github"></i> Github - Biblioteca PHP
https://github.com/mautic/api-library
Com essa biblioteca é possível realizar a integração entre o Ferramenta de Automação e qualquer aplicação PHP de forma rápida e simples.

Para evitar trabalhar com OAUTH2, aconselho realizar a autenticação de forma simples utilizando a [<i class="icon-key"></i> autenticação básica](https://github.com/mautic/api-library#using-basic-authentication-instead)

Estrutura Automação
-------------
#### <i class="icon-user"></i> Lead
A ferramenta de automação considera um *lead* cada usuário/aluno cadastrado dentro.
A todo momento da integração é necessário verificar a existência do lead ou criá-lo.

##### Fluxo Lead
```flow
st=>start: Início
e=>end: Fim
op=>operation: Aplicação Runner
op2=>operation: API cria Lead
op3=>operation: API segmentar lead
cond=>condition: Lead Existe?


st->op->cond
cond(yes)->op3->e
cond(no)->op2->e

```



A todo momento da integração vamos verificar se o lead existe

#### <i class="icon-layers"></i> Segmentos
Os segmentos são "agrupamentos" que contém um ou mais *leads*.
Após criar ou recuperar um *lead* é necessário movê-lo para um segmento via API.

Nós preparamos um documento com todos os fluxos desejados para a integração e cada uma delas moverá o *lead* para um segmento específico.

> **Exemplo:**

> - Ao se cadastrar no Experiência Runner o aluno é criado e associado ao segmento "A".
> - Se o usuário cadastrar a digital na catraca ele é MOVIDO para o segmento "B".
> - Quando o aluno comprar um plano é movido para o segmento "C".