api sales e leads

API SALES E LEADS
/ÍNDICE
2
API Sales e Leads
03
Exemplo de Requerimento
03
/ API SALES E LEADS
É uma API para acompanhamento das vendas e cadastros sem precisar consultar
na Plataforma.
Para acessar a API é preciso copiar a URL abaixo e inserir as informações
necessários, como:
Token¹: Token do Afiliado.
Aff ID: O ID do Afiliado
Date Star: Data inicial do período que deseja obter as informações de vendas ou
cadastro.
Date End: Data final do período que deseja obter as informações de vendas ou
cadastro.
/ EXEMPLO DE REQUERIMENTO
Sales
http://v2.afilio.com.br/api/leadsale_api.php?mode=list&token=<INSIRA-AQUISEU-TOKEN>&affid=<INSIRA-AQUI-SEU-AFFID>&type=sale&dateStart=<AAAA-MM-DD>&dateEnd=<AAAA-MMDD>&format=XML
Leads
http://v2.afilio.com.br/api/leadsale_api.php?mode=list&token=<INSIRA-AQUISEU-TOKEN>&affid=<INSIRA-AQUI-SEU-AFFID>&type=sale&dateStart=AAAA-MM-DD&dateEnd=AAAA-MMDD&format=XML
3
Lista de Parâmetros
NOME
mode
token
affid
progid
TIPO
STRING
STRING
STRING
AFILIO_ID*
type
STRING
dateType
STRING
dateStart
AFILIO_DATE
**
AFILIO_DATE
**
STRING
dateEnd
format
OBRIGATÓRIO
VALOR ACEITO
EXEMPLO
X
X
X
List
String
String
int or list (dois de
int separado por
“,”)
sale / lead
?mode=list
…&token=1234
…&affid=1234
…&progid=1
…&progid=1,2,
3
,4,5,25
…&type=sale
…&type=lead
…&dateType=tr
ansaction
…&dateType=v
alidation
…&dateStart=
20 14-11-31
…&dateEnd=
20 14-12-31
X
X
X
X
X
siteid
AFILIO_ID*
transaction /
validation
Data no formato
AAAA-MM-DD
Data no formato
AAAA -MM-DD
json
(default)
xml
csv
rss
…&format=xml
int or list (dois de
…&siteid=1
int separado por
…&siteid=1,2,
“,”)
3, 4,5,25
* AFILIO_ID: Significa que você pode usar um único valor ou
múltiplos valores separados por “,”. ou seja, siteID=1235 ou
siteID=1235,4564,5898
** AFILIO_DATE: A data apresenta o seguinte formato: AAAA-MMDD, onde:
 AAAA ano no formato de 4 dígitos
 MM mês no formato de 2 dígitos
 DD dia no formato de 2 dígitos
Resultado da Requisição
O resultado vai depender da sua requisição. Você pode ter requisições de
cadastro (lead) ou venda (sale) que são explicadas abaixo.
4
Campos Principais
NOME
root
list
Lead | sale
next
DESCRIÇÃO
Primeiro elemento
Lista de todos os elementos
TIPO
Object
list object
O lead object ou o sale object
depende do tipo específicado
na URL
lead object / sale
object
Próxima página
url
5
Cadastro (Lead)
NOME
lead
leadid
affid
status
DESCRIÇÃO
Nome do cadastro
ID do cadastro
ID do afiliado
Os status do cadastro
(lead):
Pendente
Aceito
Recusado
ID da campanha
ID do pedido
Valor do pedido
Comissão do Afiliado
TIPO
Object
Int
Int
String
EXEMPLO
Lead
123
123
Aceito
Int
Int
double
Double
1234
12
1.23
9999.99
date
Data e hora do pedido
no formato AAAA-MMDD HH:MM:SS
DateTime
2014-04-25
23:59:59
payment
Verificar se o pagamento
tiver sido pago ou não.
Possíveis valores:
Pago
Não pago
Campo extra
String
Paid
String(255)
Xd12
progid
order_id
order_price
comission
xtra
Venda (Sale)
NOME
sale
saleid
affid
status
progid
order_id
order_price
comission
date
payment
xtra
DESCRIÇÃO
Nome da venda
ID da venda
ID do Afiliado
Status da venda:
Possible Value:
Pendente
Aceito
Recusado
ID da campanha
ID do pedido
Preço do pedido
Comissão do Afiliado
Data e hora do pedido no
formato AAAA-MM-DD
HH:MM:SS
Verificar
se o pagamento tiver
sido pago ou não.
Possíveis valores:
Pago
Não pago
Campo extra
TIPO
Object
int
int
String
EXEMPLO
Sale
123
123
Recusado
6
Int
int
double
Double
DateTime
String
123564
order_25046
1.23
9999.99
2014-04-25
23:59:59
Unpaid
String(255)
Xd12
Observação:
¹ Como gerar o Token?
1. Logar na Plataforma
2. Ir em Minha Conta, link Informações
3. Clicar em
(1)
4. Clicar em Confirmar (2)
O código do token será disponibilizado no campo Login, em API token.
7
8
www.afil.io
t: +55 (21) 2244-8888
e: [email protected]