API
MyEduzz  |  Contato

Lista de Conteúdos

Retorna sua lista de conteúdos cadastrados na Eduzz.

Dados de Retorno:

Campo Descrição
CONTENT_ID ID do conteudo
TITLE Titulo do conteudo
DESCRIPTION Descrição do conteudo
DATE_CREATION Data de criação do conteudo
CATEGORY Categorias do conteudo
ADDITIONAL_INFORMATION Informações adicionais. Informe em detalhes como é composto este conteúdo (módulos, bônus, etc)
INFORMATION_AFFILIATE Instruções para Afiliado
PRICE Valor do conteudo
COMISSION_TYPE Tipo de comissão. Fixar valor da comissão em R$ ou um percentual da venda.
COMISSION_VALUE Comissão
PHOTO Foto do conteudo
MODERAR 1 (default): Será moderado pela nossa equipe. 0: Será moderado automaticamente, mas ficará invisível na Vitrine
FINISH_PAGE URL de Obrigado. Página que o cliente verá após finalizar o pagamento.
ACTIVE Conteúdo ativo
ALLOWS_BILLET Permite Boleto
ALLOWS_FUNIL_INFINITO Funil Infinito
FUNIL_INFINITO_COMISSION Comissão Funil
ALLOWS_RECUPERACAO_VENDA Recuperação de Venda
APPROVAL_STATUS Status da moderação
ALLOWS_AUTO_AFFILIATE Afiliação Automática?
ALLOWS_PRE_LAUNCH Pré-lançamento. O conteúdo aparecerá na vitrine, porém não será exibido o valor de venda nem a url para compra.
PARENT_CONTENT_ID Código do conteúdo Pai. (Informado caso este produto seja uma variação)
HAS_VALIDITY O produto tem validade ?
VALIDITY_DATE Data final da comercialização do conteúdo
TYPE_PAYMENT Tipo de cobrança
HAS_SIGNATURE_HIRING Tem taxa de contratação / Adesão ?
SIGNATURE_PRICE Valor da assinatura
SIGNATURE_FREQUENCY Frequência da cobrança da assinatura
SIGNATURE_FREQUENCY_TYPE Tipo da frequência
SIGNATURE_COMISSION_TYPE Tipo da comissão da assinatura
SIGNATURE_COMISSION_PRICE Valor da comissão da assinatura
HAS_SIGNATURE_CYCLE Limita ou não o número máximo de cobranças
SIGNATURE_CYCLES Numero de cobranças
HAS_SIGNATURE_TRIAL Este conteúdo tera período trial ?
SIGNATURE_TRIAL_DAYS Dias de período trial ?
HAS_PRICE_VALIDITY Preço do conteúdo tem validade ?
PRICE_VALIDITY_DATE Validade do Preço. Data que o preço do produto voltara ao valor normal.
PRICE_VALIDITY_NEW_PRICE Novo preço após data. Preço original do produto.
HAS_WEBHOOK Tem WebHook
WEBHOOK URL de integração do WebHook
VISIBLE Conteúdo aparecera na vitrine e nos funis e campanhas.
COOP_PERCENTUAIS Um array contendo os percentuais dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_NAMES Um array contendo os nomes dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_EMAILS Um array contendo os e-mails dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_IDS Um array contendo os ids dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_CODS Um array contendo os códigos exclusivos de co-produtor (diferente de COOP_IDS), vazio quando não dono
COOP_STATUS Um array informando quais co-produtores deverão emitir NF ou não. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_GERIR_AFILIADOS Um array informando quais co-produtores poderão gerir afiliados. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_SOMENTE_AFILIADOS Um array informando quais co-produtores serão comissionados Apenas sobre vendas através de afiliados. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
RECRUITMENT_URL URL para recrutamento de afiliados
EARNINGS Ganho com este conteúdo.
REVENUES Faturamento com este conteúdo.
APPROVED_AFFILIATES Quantidade de afiliados aprovados.
TOTAL_AFFILIATES Total de afiliados deste conteúdo.
TIPO_CONTEUDO Tipo do conteúdo
GET /get_contentlist

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_contentlist \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"CONTENT_ID":0,"TITLE":"","DESCRIPTION":"","DATE_CREATION":"","CATEGORY":"","ADDITIONAL_INFORMATION":"","INFORMATION_AFFILIATE":"","PRICE":0,"COMISSION_TYPE":"P","COMISSION_VALUE":0,"PHOTO":"","MODERAR":1,"FINISH_PAGE":"","ACTIVE":1,"ALLOWS_BILLET":true,"ALLOWS_FUNIL_INFINITO":true,"FUNIL_INFINITO_COMISSION":50,"ALLOWS_RECUPERACAO_VENDA":true,"APPROVAL_STATUS":"","ALLOWS_AUTO_AFFILIATE":true,"ALLOWS_PRE_LAUNCH":false,"PARENT_CONTENT_ID":0,"HAS_VALIDITY":false,"VALIDITY_DATE":"","TYPE_PAYMENT":"","HAS_SIGNATURE_HIRING":"","SIGNATURE_PRICE":0,"SIGNATURE_FREQUENCY":"","SIGNATURE_FREQUENCY_TYPE":"","SIGNATURE_COMISSION_TYPE":"","SIGNATURE_COMISSION_PRICE":"","HAS_SIGNATURE_CYCLE":false,"SIGNATURE_CYCLES":0,"HAS_SIGNATURE_TRIAL":"","SIGNATURE_TRIAL_DAYS":0,"HAS_PRICE_VALIDITY":false,"PRICE_VALIDITY_DATE":"","PRICE_VALIDITY_NEW_PRICE":0,"HAS_WEBHOOK":false,"WEBHOOK":"","VISIBLE":true,"COOP_PERCENTUAIS":[],"COOP_NAMES":[],"COOP_EMAILS":[],"COOP_IDS":[],"COOP_CODS":[],"COOP_STATUS":[],"COOP_GERIR_AFILIADOS":[],"COOP_SOMENTE_AFILIADOS":[],"RECRUITMENT_URL":"","EARNINGS":0,"REVENUES":0,"APPROVED_AFFILIATES":0,"TOTAL_AFFILIATES":0,"TIPO_CONTEUDO":""}]}

Conteúdos

Retorna seu conteúdos cadastrados na Eduzz.
O ID do conteúdo deve ser informado no campo CONTENT_ID no endereço da consulta.

Dados de Retorno:

Campo Descrição
CONTENT_ID ID do conteudo
TITLE Titulo do conteudo
DESCRIPTION Descrição do conteudo
DATE_CREATION Data de criação do conteudo
CATEGORY Categorias do conteudo
ADDITIONAL_INFORMATION Informações adicionais. Informe em detalhes como é composto este conteúdo (módulos, bônus, etc)
INFORMATION_AFFILIATE Instruções para Afiliado
PRICE Valor do conteudo
COMISSION_TYPE Tipo de comissão. Fixar valor da comissão em R$ ou um percentual da venda.
COMISSION_VALUE Comissão
PHOTO Foto do conteudo
MODERAR 1 (default): Será moderado pela nossa equipe. 0: Será moderado automaticamente, mas ficará invisível na Vitrine
FINISH_PAGE URL de Obrigado. Página que o cliente verá após finalizar o pagamento.
ACTIVE Conteúdo ativo
ALLOWS_BILLET Permite Boleto
ALLOWS_FUNIL_INFINITO Funil Infinito
FUNIL_INFINITO_COMISSION Comissão Funil
ALLOWS_RECUPERACAO_VENDA Recuperação de Venda
APPROVAL_STATUS Status da moderação
ALLOWS_AUTO_AFFILIATE Afiliação Automática?
ALLOWS_PRE_LAUNCH Pré-lançamento. O conteúdo aparecerá na vitrine, porém não será exibido o valor de venda nem a url para compra.
PARENT_CONTENT_ID Código do conteúdo Pai. (Informado caso este produto seja uma variação)
HAS_VALIDITY O produto tem validade ?
VALIDITY_DATE Data final da comercialização do conteúdo
TYPE_PAYMENT Tipo de cobrança
HAS_SIGNATURE_HIRING Tem taxa de contratação / Adesão ?
SIGNATURE_PRICE Valor da assinatura
SIGNATURE_FREQUENCY Frequência da cobrança da assinatura
SIGNATURE_FREQUENCY_TYPE Tipo da frequência
SIGNATURE_COMISSION_TYPE Tipo da comissão da assinatura
SIGNATURE_COMISSION_PRICE Valor da comissão da assinatura
HAS_SIGNATURE_CYCLE Limita ou não o número máximo de cobranças
SIGNATURE_CYCLES Numero de cobranças
HAS_SIGNATURE_TRIAL Este conteúdo tera período trial ?
SIGNATURE_TRIAL_DAYS Dias de período trial ?
HAS_PRICE_VALIDITY Preço do conteúdo tem validade ?
PRICE_VALIDITY_DATE Validade do Preço. Data que o preço do produto voltara ao valor normal.
PRICE_VALIDITY_NEW_PRICE Novo preço após data. Preço original do produto.
HAS_WEBHOOK Tem WebHook
WEBHOOK URL de integração do WebHook
VISIBLE Conteúdo aparecera na vitrine e nos funis e campanhas.
COOP_PERCENTUAIS Um array contendo os percentuais dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_NAMES Um array contendo os nomes dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_EMAILS Um array contendo os e-mails dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_IDS Um array contendo os ids dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_CODS Um array contendo os códigos exclusivos de co-produtor (diferente de COOP_IDS), vazio quando não dono
COOP_STATUS Um array informando quais co-produtores deverão emitir NF ou não. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_GERIR_AFILIADOS Um array informando quais co-produtores poderão gerir afiliados. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_SOMENTE_AFILIADOS Um array informando quais co-produtores serão comissionados Apenas sobre vendas através de afiliados. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
RECRUITMENT_URL URL para recrutamento de afiliados
EARNINGS Ganho com este conteúdo.
REVENUES Faturamento com este conteúdo.
APPROVED_AFFILIATES Quantidade de afiliados aprovados.
TOTAL_AFFILIATES Total de afiliados deste conteúdo.
TIPO_CONTEUDO Tipo do conteúdo
GET /get_content/{CONTENT_ID}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":{"CONTENT_ID":0,"TITLE":"","DESCRIPTION":"","DATE_CREATION":"","CATEGORY":"","ADDITIONAL_INFORMATION":"","INFORMATION_AFFILIATE":"","PRICE":0,"COMISSION_TYPE":"P","COMISSION_VALUE":0,"PHOTO":"","MODERAR":1,"FINISH_PAGE":"","ACTIVE":1,"ALLOWS_BILLET":true,"ALLOWS_FUNIL_INFINITO":true,"FUNIL_INFINITO_COMISSION":50,"ALLOWS_RECUPERACAO_VENDA":true,"APPROVAL_STATUS":"","ALLOWS_AUTO_AFFILIATE":true,"ALLOWS_PRE_LAUNCH":false,"PARENT_CONTENT_ID":0,"HAS_VALIDITY":false,"VALIDITY_DATE":"","TYPE_PAYMENT":"","HAS_SIGNATURE_HIRING":"","SIGNATURE_PRICE":0,"SIGNATURE_FREQUENCY":"","SIGNATURE_FREQUENCY_TYPE":"","SIGNATURE_COMISSION_TYPE":"","SIGNATURE_COMISSION_PRICE":"","HAS_SIGNATURE_CYCLE":false,"SIGNATURE_CYCLES":0,"HAS_SIGNATURE_TRIAL":"","SIGNATURE_TRIAL_DAYS":0,"HAS_PRICE_VALIDITY":false,"PRICE_VALIDITY_DATE":"","PRICE_VALIDITY_NEW_PRICE":0,"HAS_WEBHOOK":false,"WEBHOOK":"","VISIBLE":true,"COOP_PERCENTUAIS":[],"COOP_NAMES":[],"COOP_EMAILS":[],"COOP_IDS":[],"COOP_CODS":[],"COOP_STATUS":[],"COOP_GERIR_AFILIADOS":[],"COOP_SOMENTE_AFILIADOS":[],"RECRUITMENT_URL":"","EARNINGS":0,"REVENUES":0,"APPROVED_AFFILIATES":0,"TOTAL_AFFILIATES":0,"TIPO_CONTEUDO":""}}

Alterar Status

Altera o status do seu conteúdo.
O ID do conteúdo deve ser informado no campo CONTENT_ID no endereço da requisição.
O status do conteúdo deve ser inteiro 0 para ativo ou inteiro 1 para inativo no campo ACTIVE no corpo da requisição.

 

Descrição dos campos:

Campo Descrição
ACTIVE Conteúdo ativo
POST /update_content_status/{CONTENT_ID}

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/update_content_status/{CONTENT_ID} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"ACTIVE":0}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[]}

Alterar Conteúdo

Altera o seu conteúdo.
O ID do conteúdo deve ser informado no campo CONTENT_ID no endereço da consulta.
 

Descrição dos campos:

Campo Descrição
TITLE Titulo do conteudo
DESCRIPTION Descrição do conteudo
CATEGORY Categorias do conteudo
ADDITIONAL_INFORMATION Informações adicionais. Informe em detalhes como é composto este conteúdo (módulos, bônus, etc)
INFORMATION_AFFILIATE Instruções para Afiliado
PRICE Valor do conteudo
COMISSION_TYPE Tipo de comissão. Fixar valor da comissão em R$ ou um percentual da venda.
COMISSION_VALUE Comissão
PHOTO Foto do conteudo
MODERAR 1 (default): Será moderado pela nossa equipe. 0: Será moderado automaticamente, mas ficará invisível na Vitrine
FINISH_PAGE URL de Obrigado. Página que o cliente verá após finalizar o pagamento.
ACTIVE Conteúdo ativo
ALLOWS_BILLET Permite Boleto
ALLOWS_FUNIL_INFINITO Funil Infinito
FUNIL_INFINITO_COMISSION Comissão Funil
ALLOWS_RECUPERACAO_VENDA Recuperação de Venda
ALLOWS_AUTO_AFFILIATE Afiliação Automática?
ALLOWS_PRE_LAUNCH Pré-lançamento. O conteúdo aparecerá na vitrine, porém não será exibido o valor de venda nem a url para compra.
HAS_VALIDITY O produto tem validade ?
VALIDITY_DATE Data final da comercialização do conteúdo
TYPE_PAYMENT Tipo de cobrança
HAS_SIGNATURE_HIRING Tem taxa de contratação / Adesão ?
SIGNATURE_PRICE Valor da assinatura
SIGNATURE_FREQUENCY Frequência da cobrança da assinatura
SIGNATURE_FREQUENCY_TYPE Tipo da frequência
SIGNATURE_COMISSION_TYPE Tipo da comissão da assinatura
SIGNATURE_COMISSION_PRICE Valor da comissão da assinatura
HAS_SIGNATURE_CYCLE Limita ou não o número máximo de cobranças
SIGNATURE_CYCLES Numero de cobranças
HAS_SIGNATURE_TRIAL Este conteúdo tera período trial ?
SIGNATURE_TRIAL_DAYS Dias de período trial ?
HAS_PRICE_VALIDITY Preço do conteúdo tem validade ?
PRICE_VALIDITY_DATE Validade do Preço. Data que o preço do produto voltara ao valor normal.
PRICE_VALIDITY_NEW_PRICE Novo preço após data. Preço original do produto.
HAS_WEBHOOK Tem WebHook
WEBHOOK URL de integração do WebHook
VISIBLE Conteúdo aparecera na vitrine e nos funis e campanhas.
COOP_PERCENTUAIS Um array contendo os percentuais dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_NAMES Um array contendo os nomes dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_EMAILS Um array contendo os e-mails dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_IDS Um array contendo os ids dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_CODS Um array contendo os códigos exclusivos de co-produtor (diferente de COOP_IDS), vazio quando não dono
COOP_STATUS Um array informando quais co-produtores deverão emitir NF ou não. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_GERIR_AFILIADOS Um array informando quais co-produtores poderão gerir afiliados. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_SOMENTE_AFILIADOS Um array informando quais co-produtores serão comissionados Apenas sobre vendas através de afiliados. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
RECRUITMENT_URL URL para recrutamento de afiliados
EARNINGS Ganho com este conteúdo.
REVENUES Faturamento com este conteúdo.
APPROVED_AFFILIATES Quantidade de afiliados aprovados.
TOTAL_AFFILIATES Total de afiliados deste conteúdo.
TIPO_CONTEUDO Tipo do conteúdo
POST /update_content/{CONTENT_ID}

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/update_content/{CONTENT_ID} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"TITLE":"","DESCRIPTION":"","CATEGORY":"","ADDITIONAL_INFORMATION":"","INFORMATION_AFFILIATE":"","PRICE":0,"COMISSION_TYPE":"P","COMISSION_VALUE":0,"PHOTO":"","MODERAR":1,"FINISH_PAGE":"","ACTIVE":1,"ALLOWS_BILLET":true,"ALLOWS_FUNIL_INFINITO":true,"FUNIL_INFINITO_COMISSION":50,"ALLOWS_RECUPERACAO_VENDA":true,"ALLOWS_AUTO_AFFILIATE":true,"ALLOWS_PRE_LAUNCH":false,"HAS_VALIDITY":false,"VALIDITY_DATE":"","TYPE_PAYMENT":"","HAS_SIGNATURE_HIRING":"","SIGNATURE_PRICE":0,"SIGNATURE_FREQUENCY":"","SIGNATURE_FREQUENCY_TYPE":"","SIGNATURE_COMISSION_TYPE":"","SIGNATURE_COMISSION_PRICE":"","HAS_SIGNATURE_CYCLE":false,"SIGNATURE_CYCLES":0,"HAS_SIGNATURE_TRIAL":"","SIGNATURE_TRIAL_DAYS":0,"HAS_PRICE_VALIDITY":false,"PRICE_VALIDITY_DATE":"","PRICE_VALIDITY_NEW_PRICE":0,"HAS_WEBHOOK":false,"WEBHOOK":"","VISIBLE":true,"COOP_PERCENTUAIS":[],"COOP_NAMES":[],"COOP_EMAILS":[],"COOP_IDS":[],"COOP_CODS":[],"COOP_STATUS":[],"COOP_GERIR_AFILIADOS":[],"COOP_SOMENTE_AFILIADOS":[],"RECRUITMENT_URL":"","EARNINGS":0,"REVENUES":0,"APPROVED_AFFILIATES":0,"TOTAL_AFFILIATES":0,"TIPO_CONTEUDO":""}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[]}

Criar Conteúdo

Criar um novo conteúdo.

 

Descrição dos campos:

Campo Descrição
TITLE Titulo do conteudo
DESCRIPTION Descrição do conteudo
CATEGORY Categorias do conteudo
ADDITIONAL_INFORMATION Informações adicionais. Informe em detalhes como é composto este conteúdo (módulos, bônus, etc)
INFORMATION_AFFILIATE Instruções para Afiliado
PRICE Valor do conteudo
COMISSION_TYPE Tipo de comissão. Fixar valor da comissão em R$ ou um percentual da venda.
COMISSION_VALUE Comissão
PHOTO Foto do conteudo
MODERAR 1 (default): Será moderado pela nossa equipe. 0: Será moderado automaticamente, mas ficará invisível na Vitrine
FINISH_PAGE URL de Obrigado. Página que o cliente verá após finalizar o pagamento.
ACTIVE Conteúdo ativo
ALLOWS_BILLET Permite Boleto
ALLOWS_FUNIL_INFINITO Funil Infinito
FUNIL_INFINITO_COMISSION Comissão Funil
ALLOWS_RECUPERACAO_VENDA Recuperação de Venda
ALLOWS_AUTO_AFFILIATE Afiliação Automática?
ALLOWS_PRE_LAUNCH Pré-lançamento. O conteúdo aparecerá na vitrine, porém não será exibido o valor de venda nem a url para compra.
HAS_VALIDITY O produto tem validade ?
VALIDITY_DATE Data final da comercialização do conteúdo
TYPE_PAYMENT Tipo de cobrança
HAS_SIGNATURE_HIRING Tem taxa de contratação / Adesão ?
SIGNATURE_PRICE Valor da assinatura
SIGNATURE_FREQUENCY Frequência da cobrança da assinatura
SIGNATURE_FREQUENCY_TYPE Tipo da frequência
SIGNATURE_COMISSION_TYPE Tipo da comissão da assinatura
SIGNATURE_COMISSION_PRICE Valor da comissão da assinatura
HAS_SIGNATURE_CYCLE Limita ou não o número máximo de cobranças
SIGNATURE_CYCLES Numero de cobranças
HAS_SIGNATURE_TRIAL Este conteúdo tera período trial ?
SIGNATURE_TRIAL_DAYS Dias de período trial ?
HAS_PRICE_VALIDITY Preço do conteúdo tem validade ?
PRICE_VALIDITY_DATE Validade do Preço. Data que o preço do produto voltara ao valor normal.
PRICE_VALIDITY_NEW_PRICE Novo preço após data. Preço original do produto.
HAS_WEBHOOK Tem WebHook
WEBHOOK URL de integração do WebHook
VISIBLE Conteúdo aparecera na vitrine e nos funis e campanhas.
COOP_PERCENTUAIS Um array contendo os percentuais dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_NAMES Um array contendo os nomes dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_EMAILS Um array contendo os e-mails dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_IDS Um array contendo os ids dos co-produtores. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_CODS Um array contendo os códigos exclusivos de co-produtor (diferente de COOP_IDS), vazio quando não dono
COOP_STATUS Um array informando quais co-produtores deverão emitir NF ou não. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_GERIR_AFILIADOS Um array informando quais co-produtores poderão gerir afiliados. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
COOP_SOMENTE_AFILIADOS Um array informando quais co-produtores serão comissionados Apenas sobre vendas através de afiliados. O primeiro deve ser referente ao do produtor principal, vazio quando não dono
RECRUITMENT_URL URL para recrutamento de afiliados
EARNINGS Ganho com este conteúdo.
REVENUES Faturamento com este conteúdo.
APPROVED_AFFILIATES Quantidade de afiliados aprovados.
TOTAL_AFFILIATES Total de afiliados deste conteúdo.
TIPO_CONTEUDO Tipo do conteúdo

Dados de Retorno:

Campo Descrição
CONTENT_ID ID do conteudo criado
POST /create_content

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/create_content \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"TITLE":"","DESCRIPTION":"","CATEGORY":"","ADDITIONAL_INFORMATION":"","INFORMATION_AFFILIATE":"","PRICE":0,"COMISSION_TYPE":"P","COMISSION_VALUE":0,"PHOTO":"","MODERAR":1,"FINISH_PAGE":"","ACTIVE":1,"ALLOWS_BILLET":true,"ALLOWS_FUNIL_INFINITO":true,"FUNIL_INFINITO_COMISSION":50,"ALLOWS_RECUPERACAO_VENDA":true,"ALLOWS_AUTO_AFFILIATE":true,"ALLOWS_PRE_LAUNCH":false,"HAS_VALIDITY":false,"VALIDITY_DATE":"","TYPE_PAYMENT":"","HAS_SIGNATURE_HIRING":"","SIGNATURE_PRICE":0,"SIGNATURE_FREQUENCY":"","SIGNATURE_FREQUENCY_TYPE":"","SIGNATURE_COMISSION_TYPE":"","SIGNATURE_COMISSION_PRICE":"","HAS_SIGNATURE_CYCLE":false,"SIGNATURE_CYCLES":0,"HAS_SIGNATURE_TRIAL":"","SIGNATURE_TRIAL_DAYS":0,"HAS_PRICE_VALIDITY":false,"PRICE_VALIDITY_DATE":"","PRICE_VALIDITY_NEW_PRICE":0,"HAS_WEBHOOK":false,"WEBHOOK":"","VISIBLE":true,"COOP_PERCENTUAIS":[],"COOP_NAMES":[],"COOP_EMAILS":[],"COOP_IDS":[],"COOP_CODS":[],"COOP_STATUS":[],"COOP_GERIR_AFILIADOS":[],"COOP_SOMENTE_AFILIADOS":[],"RECRUITMENT_URL":"","EARNINGS":0,"REVENUES":0,"APPROVED_AFFILIATES":0,"TOTAL_AFFILIATES":0,"TIPO_CONTEUDO":""}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":{"CONTENT_ID":9999}}

Lista de Categorias

Retorna a lista de categorias da Eduzz.
GET /get_categorylist

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_categorylist \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"CATEGORY_ID":0,"TITLE":"","PARENT_CATEGORY_ID":0}]}

Endereço

Consulta o endereço do cliente.
 

Dados de Retorno:

Campo Descrição
STREET Nome da Rua
NUMBER Número da casa
COMPLEMENT Complemento
ZIP_CODE CEP
NEIGHBORHOOD Bairro
CITY Cidade
STATE Unidade da Federação/Estado
COUNTRY Pais
GET /get_address/{CUSTOMER_ID}

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_address/{CUSTOMER_ID} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"STREET":"","NUMBER":"","COMPLEMENT":"","ZIP_CODE":"","NEIGHBORHOOD":"","CITY":"","STATE":"","COUNTRY":""}]}

Lista de Campanhas

Retorna a lista de todas as Campanhas ou de um conteúdo específico.

Dados de Requesição:

Campo Descrição
CONTENT_ID ID do conteudo (opcional)

 

Dados de Retorno:

Campo Descrição
CAMPAIGN_ID ID da Campanha
CONTENT_ID ID do conteudo
NAME Nome da campanha
URL URL de destino da campanha
ACTIVE Campanha ativa
KEY Chave da campanha
URL_CAMPAIGN Url de divulgação da campanha
GET /get_campaignslist

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_campaignslist \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"CONTENT_ID":0}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"CAMPAIGN_ID":0,"CONTENT_ID":0,"NAME":"","URL":"","ACTIVE":true,"KEY":"","URL_CAMPAIGN":""}]}

Lista de Vendas

Retorna sua lista de vendas realizadas na Eduzz.
 

Dados de Requesição:

Campo Descrição
DATE_START
DATE_END
START Página que vai ser retornada
LENGTH Quantidade de itens nessa página
CONTENT_ID
CLIENT_ID
CLIENT_EMAIL Email do comprador
SALE_STATUS
SALE_PAYMENT_METHOD
GROUP_BY_INVOICE
AFFILIATE_IDS IDs dos afiliados, separados por vírgula

 

Dados de Retorno:

Campo Descrição
SALE_ID ID da fatura
DATE_CREATE Data de criação da fatura
DATE_PAYMENT Data de pagamento
SALE_STATUS Status da venda
CURRENCY Moeda
SALE_ITEM_ID ID do item na fatura
SALE_ITEM_DISCOUNT Valor de desconto
SALE_RECUPERACAO Fatura recuperada
SALE_URL_BOLETO URL de recuperacao - pagamento por boleto
SALE_URL_CARTAO URL de recuperacao - pagamento por cartão
SALE_FUNIL_INFINITO
SALE_PAYMENT_METHOD Método de pagamento
SALE_AMOUNT_WIN Quantidade ganha
SALE_NET_GAIN Valor líquido
SALE_COOP Valor da comissão do co-produtor
SALE_PARTNER Valor da comissão do afiliado
SALE_FEE Taxa Eduzz
SALE_OTHERS Outros descontos
CLIENT_ID ID do Cliente
CLIENT_NAME Nome do cliente
CLIENT_EMAIL E-mail do cliente
CLIENT_DOCUMENT Documento do cliente
CLIENT_CEL Documento do cliente
CLIENT_UF UF do cliente
CLIENT_FIST_ACCESS_ID ID do Log de primeiro acesso do cliente
SALE_TOTAL Valor total da venda
CONTENT_ID ID do conteúdo
CONTENT_TITLE Nome do conteudo
PRODUCER_ID ID do produtor do conteudo
AFFILIATE_ID ID do afiliado que gerou a venda
PRODUCER_NAME Nome do produtor do conteudo
AFFILIATE_NAME Nome do afiliado que gerou a venda
UTM_SOURCE UTM Source
UTM_CAMPAIGN UTM Campaign
UTM_MEDIUM UTM Medium
UTM_CONTENT UTM Content
POST /get_saleslist

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_saleslist \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"DATE_START":"2019-06-08 00:00:00","DATE_END":"2019-06-15 18:06:44","START":"1","LENGTH":"10","CONTENT_ID":[0],"CLIENT_ID":0,"CLIENT_EMAIL":"","SALE_STATUS":[0],"SALE_PAYMENT_METHOD":[0],"GROUP_BY_INVOICE":0,"AFFILIATE_IDS":"123, 123..."}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"SALE_ID":0,"DATE_CREATE":"","DATE_PAYMENT":"","SALE_STATUS":0,"CURRENCY":"","SALE_ITEM_ID":0,"SALE_ITEM_DISCOUNT":0,"SALE_RECUPERACAO":false,"SALE_URL_BOLETO":"","SALE_URL_CARTAO":"","SALE_FUNIL_INFINITO":false,"SALE_PAYMENT_METHOD":0,"SALE_AMOUNT_WIN":0,"SALE_NET_GAIN":0,"SALE_COOP":0,"SALE_PARTNER":0,"SALE_FEE":0,"SALE_OTHERS":0,"CLIENT_ID":0,"CLIENT_NAME":"","CLIENT_EMAIL":"","CLIENT_DOCUMENT":"","CLIENT_CEL":"","CLIENT_UF":"","CLIENT_FIST_ACCESS_ID":0,"SALE_TOTAL":0,"CONTENT_ID":0,"CONTENT_TITLE":"","PRODUCER_ID":0,"AFFILIATE_ID":0,"PRODUCER_NAME":"","AFFILIATE_NAME":"","UTM_SOURCE":"","UTM_CAMPAIGN":"","UTM_MEDIUM":"","UTM_CONTENT":""}]}

Venda

Retorna as informações de sua venda realizadas na Eduzz.
 

Dados de Retorno:

Campo Descrição
SALE_ID ID da fatura
DATE_CREATE Data de criação da fatura
DATE_PAYMENT Data de pagamento
SALE_STATUS Status da venda
CURRENCY Moeda
SALE_ITEM_ID ID do item na fatura
SALE_ITEM_DISCOUNT Valor de desconto
SALE_RECUPERACAO Fatura recuperada
SALE_URL_BOLETO URL de recuperacao - pagamento por boleto
SALE_URL_CARTAO URL de recuperacao - pagamento por cartão
SALE_FUNIL_INFINITO
SALE_PAYMENT_METHOD Método de pagamento
SALE_AMOUNT_WIN Quantidade ganha
SALE_NET_GAIN Valor líquido
SALE_COOP Valor da comissão do co-produtor
SALE_PARTNER Valor da comissão do afiliado
SALE_FEE Taxa Eduzz
SALE_OTHERS Outros descontos
CLIENT_ID ID do Cliente
CLIENT_NAME Nome do cliente
CLIENT_EMAIL E-mail do cliente
CLIENT_DOCUMENT Documento do cliente
CLIENT_CEL Documento do cliente
CLIENT_UF UF do cliente
CLIENT_FIST_ACCESS_ID ID do Log de primeiro acesso do cliente
SALE_TOTAL Valor total da venda
CONTENT_ID ID do conteúdo
CONTENT_TITLE Nome do conteudo
PRODUCER_ID ID do produtor do conteudo
AFFILIATE_ID ID do afiliado que gerou a venda
PRODUCER_NAME Nome do produtor do conteudo
AFFILIATE_NAME Nome do afiliado que gerou a venda
UTM_SOURCE UTM Source
UTM_CAMPAIGN UTM Campaign
UTM_MEDIUM UTM Medium
UTM_CONTENT UTM Content
GET /get_sale/{SALE_ID}

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_sale/{SALE_ID} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":{"SALE_ID":0,"DATE_CREATE":"","DATE_PAYMENT":"","SALE_STATUS":0,"CURRENCY":"","SALE_ITEM_ID":0,"SALE_ITEM_DISCOUNT":0,"SALE_RECUPERACAO":false,"SALE_URL_BOLETO":"","SALE_URL_CARTAO":"","SALE_FUNIL_INFINITO":false,"SALE_PAYMENT_METHOD":0,"SALE_AMOUNT_WIN":0,"SALE_NET_GAIN":0,"SALE_COOP":0,"SALE_PARTNER":0,"SALE_FEE":0,"SALE_OTHERS":0,"CLIENT_ID":0,"CLIENT_NAME":"","CLIENT_EMAIL":"","CLIENT_DOCUMENT":"","CLIENT_CEL":"","CLIENT_UF":"","CLIENT_FIST_ACCESS_ID":0,"SALE_TOTAL":0,"CONTENT_ID":0,"CONTENT_TITLE":"","PRODUCER_ID":0,"AFFILIATE_ID":0,"PRODUCER_NAME":"","AFFILIATE_NAME":"","UTM_SOURCE":"","UTM_CAMPAIGN":"","UTM_MEDIUM":"","UTM_CONTENT":""}}

Detalhes da venda

Retorna os detalhes da sua venda.
 

Dados de Requisição:

Campo Descrição
SALE_ID ID da fatura
SALE_ITEM_ID ID do item na fatura

 

Dados de Retorno:

Campo Descrição
CONTENT_ID Código do conteudo
FILE_ID
CONTENT_TITLE Nome do conteúdo
PRODUCER_ID
TYPE_PAYMENT
PRODUCER_NAME Razão social do produtor
SALE_ID
SALE_STATUS
DATE_CREATE
DATE_MATURITY
DATE_PAYMENT
SALE_RECUPERACAO
SALE_PARCELAS
CLIENT_FIST_ACCESS_ID
SALE_ITEM_DISCOUNT
CONTENT_KEY
COUPON_VALUE
COUPON_TYPE
COMMISSION_SALEVALUE
COMMISSION_LIQUIDVALUE
COMMISSION_TAXVALUE
COMMISSION_VALUE
PARTNER_VALUE
COMMISSION_VALUEANT
COMMISSION_VALUEOTHERS
COMMISSION_CREDITDATE
COMMISSION_FUNNEL
COMMISSION_BLOCKED
COMMISSION_COAP
CLIENT_ID Código do cliente
CLIENT_NAME Razão social do cliente
CLIENT_TAXID CPF/CNPJ do cliente
CLIENT_EMAIL Email do cliente
CLIENT_STREET Endereço do cliente
CLIENT_ADDRESSNUMBER Nº do endereço do cliente
CLIENT_COMPLEMENT Complemento do endereço do cliente
CLIENT_NEIGHBORHOOD Bairro do cliente
CLIENT_ZIPCODE CEP do cliente
CLIENT_PHONE Telefone do cliente
CLIENT_PHONE2
CLIENT_CELLPHONE Celular do cliente
CITY
STATE
GATEWAY_CODE
GATEWAY_KEY
GATEWAY_SOURCE
GATEWAY_CAMPAIGN
GATEWAY_MEDIUM
GATEWAY_CONTENT
GATEWAY_DIST
GATEWAY_CART
AFFILIATE_ID
AFFILIATE_NAME
AFFILIATE_COMPANY
PAYMENT_ID
PAYMENT_NAME Forma de pagamento
DOCUMENT_ID
DOCUMENT_DATE
DOCUMENT_TAXID
IS_PRODUCER É ou não produtor (S/N)
GET /get_sale_detail/{SALE_ID}/{SALE_ITEM_ID}

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_sale_detail/{SALE_ID}/{SALE_ITEM_ID} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"CONTENT_ID":0,"FILE_ID":0,"CONTENT_TITLE":"","PRODUCER_ID":0,"TYPE_PAYMENT":"","PRODUCER_NAME":"","SALE_ID":0,"SALE_STATUS":0,"DATE_CREATE":"","DATE_MATURITY":"","DATE_PAYMENT":"","SALE_RECUPERACAO":0,"SALE_PARCELAS":0,"CLIENT_FIST_ACCESS_ID":0,"SALE_ITEM_DISCOUNT":0,"CONTENT_KEY":"","COUPON_VALUE":0,"COUPON_TYPE":"","COMMISSION_SALEVALUE":0,"COMMISSION_LIQUIDVALUE":0,"COMMISSION_TAXVALUE":0,"COMMISSION_VALUE":0,"PARTNER_VALUE":0,"COMMISSION_VALUEANT":0,"COMMISSION_VALUEOTHERS":0,"COMMISSION_CREDITDATE":"","COMMISSION_FUNNEL":0,"COMMISSION_BLOCKED":0,"COMMISSION_COAP":0,"CLIENT_ID":0,"CLIENT_NAME":"","CLIENT_TAXID":"","CLIENT_EMAIL":"","CLIENT_STREET":"","CLIENT_ADDRESSNUMBER":0,"CLIENT_COMPLEMENT":"","CLIENT_NEIGHBORHOOD":"","CLIENT_ZIPCODE":"","CLIENT_PHONE":"","CLIENT_PHONE2":0,"CLIENT_CELLPHONE":"","CITY":"","STATE":"","GATEWAY_CODE":"","GATEWAY_KEY":0,"GATEWAY_SOURCE":0,"GATEWAY_CAMPAIGN":0,"GATEWAY_MEDIUM":0,"GATEWAY_CONTENT":0,"GATEWAY_DIST":0,"GATEWAY_CART":0,"AFFILIATE_ID":0,"AFFILIATE_NAME":"","AFFILIATE_COMPANY":"","PAYMENT_ID":0,"PAYMENT_NAME":"","DOCUMENT_ID":0,"DOCUMENT_DATE":0,"DOCUMENT_TAXID":0,"IS_PRODUCER":""}]}

Solicitar Reembolso

Abre uma Solicitação de Reembolso de uma Fatura.
 

Dados de Requisição:

Campo Descrição
SALE_ID ID da fatura

 

Dados de Retorno:

Campo Descrição
SALE_HISTORY_ID ID do Histórico gerado da Fatura
DATE_CREATE Data do Histórico gerado da Fatura
DESCRIPTION Descrição do Histórico gerado da Fatura
GET /request_refund/{SALE_ID}

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/request_refund/{SALE_ID} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":{"SALE_HISTORY_ID":0,"DATE_CREATE":"","DESCRIPTION":""}}

Enviar Código de Rastreio

Envia código de rastreio dos correios de produtos físicos.

 

Dados de Requisição:

Campo Descrição
SALE_ITEM_ID ID do item da fatura
TRACKING_CODE Código de rastreio do produto
POST /set_tracking_code

Exemplo da Requisição

$ curl http://my.eduzz.com/api2/set_tracking_code \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    [{"SALE_ITEM_ID":"","TRACKING_CODE":""}]

Cancelar Assinatura

Cancela uma Assinatura
 

Dados de Requisição:

Campo Descrição
SALE_ID ID da fatura

 

Dados de Retorno:

Campo Descrição
SALE_HISTORY_ID ID do Histórico gerado da Fatura
DATE_CREATE Data do Histórico gerado da Fatura
DESCRIPTION Descrição do Histórico gerado da Fatura
GET /cancel_subscription/{SALE_ID}

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/cancel_subscription/{SALE_ID} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":{"SALE_HISTORY_ID":0,"DATE_CREATE":"","DESCRIPTION":""}}

Contrato

Consulta os dados de um contrato de assinatura.
 

Dados de Retorno:

Campo Descrição
CONTRACT_ID Código do contrato
CONTRACT_START_DATE Data de início do contrato
CONTRACT_STATUS Status do contrato
CONTRACT_INVOICE Número da fatura de inicio do contrato
CUSTOMER_ID Código do cliente
CUSTOMER_NAME Nome do Cliente
CUSTOMER_DOCUMENT Documento do cliente
CUSTOMER_DOCUMENT_TYPE Tipo de documento cpf ou cnpj
CUSTOMER_EMAIL E-mail do cliente
PRODUCT_ID Código do produto
PRODUCT_NAME Nome do produto
PAYMENT_QUANTITY Quantidade de parcelas
PAYMENT_VALUE Valor mensal da assinatura
PAYMENT_METHOD Forma de pagamento
PAYMENT_DATE_NEXT_PAYMENT Data da próxima cobrança
PAYMENT_DATE_LAST_PAYMENT Data da última cobrança
PAYMENT_HISTORY Histórico de pagamentos efetuados
GET /get_contract/{CONTRACT_ID}

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_contract/{CONTRACT_ID} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":{"CONTRACT_ID":"","CONTRACT_START_DATE":"","CONTRACT_STATUS":"","CONTRACT_INVOICE":"","CUSTOMER_ID":"","CUSTOMER_NAME":"","CUSTOMER_DOCUMENT":"","CUSTOMER_DOCUMENT_TYPE":"","CUSTOMER_EMAIL":"","PRODUCT_ID":"","PRODUCT_NAME":"","PAYMENT_QUANTITY":"","PAYMENT_VALUE":"","PAYMENT_METHOD":"","PAYMENT_DATE_NEXT_PAYMENT":"","PAYMENT_DATE_LAST_PAYMENT":"","PAYMENT_HISTORY":""}}

Lista de Contratos

Consultar lista de contratos de assinatura.
 

Dados de Requisição:

Campo Descrição
START A página consultada
LENGTH A quantidade de itens na página

 

Dados de Retorno:

Campo Descrição
CONTRACT_ID Código do contrato
CONTRACT_START_DATE Data de início do contrato
CONTRACT_STATUS Status do contrato
CONTRACT_INVOICE Número da fatura de inicio do contrato
CUSTOMER_ID Código do cliente
CUSTOMER_NAME Nome do Cliente
CUSTOMER_DOCUMENT Documento do cliente
CUSTOMER_DOCUMENT_TYPE Tipo de documento cpf ou cnpj
CUSTOMER_EMAIL E-mail do cliente
PRODUCT_ID Código do produto
PRODUCT_NAME Nome do produto
PAYMENT_QUANTITY Quantidade de parcelas
PAYMENT_VALUE Valor mensal da assinatura
PAYMENT_METHOD Forma de pagamento
PAYMENT_DATE_NEXT_PAYMENT Data da próxima cobrança
PAYMENT_DATE_LAST_PAYMENT Data da última cobrança
GET /get_contractlist

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_contractlist \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"START":0,"LENGTH":0}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"CONTRACT_ID":"","CONTRACT_START_DATE":"","CONTRACT_STATUS":"","CONTRACT_INVOICE":"","CUSTOMER_ID":"","CUSTOMER_NAME":"","CUSTOMER_DOCUMENT":"","CUSTOMER_DOCUMENT_TYPE":"","CUSTOMER_EMAIL":"","PRODUCT_ID":"","PRODUCT_NAME":"","PAYMENT_QUANTITY":"","PAYMENT_VALUE":"","PAYMENT_METHOD":"","PAYMENT_DATE_NEXT_PAYMENT":"","PAYMENT_DATE_LAST_PAYMENT":""}]}

Meio de Pagamento

Consulta as formas de pagamento do cliente.
 

Dados de Retorno:

Campo Descrição
CUSTOMER_ID Código do cliente
TOKEN Token do meio de pagamento
REGISTRATION_DATE Data de cadastro da forma de pagamemto
LAST_DIGITS Ultimos quatro digitos do cartão de credito
BRAND Bandeira do cartão de credito
GET /get_paymentMethod/{CUSTOMER_ID}

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_paymentMethod/{CUSTOMER_ID} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"CUSTOMER_ID":"","TOKEN":"","REGISTRATION_DATE":"","LAST_DIGITS":"","BRAND":""}]}

Lista de afiliados

Retorna sua lista de afiliados.
 

Dados de Requisição:

Campo Descrição
PRODUCT_ID Código do produto a ser filtrado

 

Dados de Retorno:

Campo Descrição
PRODUCT_ID Código do produto
PRODUCT_TITLE Título do produto
AFFILIATE_ID Código do afiliado
AFFILIATE_NAME Nome do afiliado
AFFILIATION_STATUS Status da afiliação
GET /get_affiliateslist

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_affiliateslist \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"PRODUCT_ID":0,"PRODUCT_TITLE":"","AFFILIATE_ID":0,"AFFILIATE_NAME":"","AFFILIATION_STATUS":""}]}

Minhas afiliações

Retorna sua lista de afiliações.
 

Dados de Retorno:

Campo Descrição
PRODUCT_ID Código do produto
PRODUCT_TITLE Título do produto
PRODUCER_ID Código do produtor
PRODUCER_NAME Nome do produtor
AFFILIATION_STATUS Status da afiliação
GET /get_myaffiliationslist

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_myaffiliationslist \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"PRODUCT_ID":0,"PRODUCT_TITLE":"","PRODUCER_ID":0,"PRODUCER_NAME":"","AFFILIATION_STATUS":""}]}

Alterar Status da Afiliação

Altera o Status da afiliação.
O ID do produto, ID do afiliado e novo status devem ser informado no endereço da consulta.
 

Dados de Requisição:

Campo Descrição
PRODUCT_ID Código do produto
CLIENT_ID Código do afiliado
AFFILIATION_STATUS Novo status da afiliação

 

Opções de Status:

Campo Descrição
R Reprovado
A Aprovado
GET /set_affiliation_status/{PRODUCT_ID}/{CLIENT_ID}/{AFFILIATION_STATUS}

Exemplo da Requisição

$ curl http://my.eduzz.com/api2/set_affiliation_status/{PRODUCT_ID}/{CLIENT_ID}/{AFFILIATION_STATUS} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

TOP afiliados

Mostra o Top afiliados com mais vendas.

 

Dados de Requisição:

Campo Descrição
CONTENT_ID Código do conteúdo. para desconsiderar este paramêtro informar zero.
LIMIT Quantidade de registros retornados na consulta. Limitado a 10 registros por padrão.

 

Opções de Status:

Campo Descrição
AFFILIATE_ID Código do afiliado
AFFILIATE_NAME Nome do afiliado
VALUE Valor total
GET /get_top_afiliados_conteudo/{CONTENT_ID}/{LIMIT}

Exemplo da Requisição

$ curl http://my.eduzz.com/api2/get_top_afiliados_conteudo/{CONTENT_ID}/{LIMIT} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"AFFILIATE_ID":"","AFFILIATE_NAME":"","VALUE":""}]}

Produtos

Retorna a lista de produtos filtrados.
 

Filtros disponíveis:

Campo Descrição
PRICE_RANGE Preço entre X-Y
CATEGORY_ID Código da categoria do produto
FORMAT Formato do produto a ser filtrado
FUNIL Se o produto deve ter funil
COMISSION Comissão aproximada do produto
INFO_PRODUCT Se o produto é do tipo info-produto
FREE Se devemos incluir produtos gratuitos

 

Dados de Retorno:

Campo Descrição
PRODUCT_ID Código do produto
PRODUCT_TITLE Título do produto
PRODUCT_LOGO Logo do produto
PRODUCT_RECOVERY Recuperação de vendas
PRODUCER_NAME Produtor
PRODUCT_COMISSION Comissão
PRODUCT_FUNIL Funil infinito
PRODUCT_RPCAFFILIATE RPC Afiliado
PRODUCT_RPCPRODUCER RPC Produtor
PRODUCT_RATING Avaliação do produto
PRODUCT_PRICE Preço do produto
GET /get_showcase

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_showcase \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"PRODUCT_ID":0,"PRODUCT_TITLE":"","PRODUCT_LOGO":"","PRODUCT_RECOVERY":0,"PRODUCER_NAME":"","PRODUCT_COMISSION":"","PRODUCT_FUNIL":0,"PRODUCT_RPCAFFILIATE":"","PRODUCT_RPCPRODUCER":"","PRODUCT_RATING":0,"PRODUCT_PRICE":"1-100"}]}

Produtos mais vendidos

Retorna a lista de produtos mais vendidos.
 

Dados de Retorno:

Campo Descrição
PRODUCT_ID Código do produto
PRODUCT_TITLE Título do produto
PRODUCT_LOGO Logo do produto
PRODUCT_RECOVERY Recuperação de vendas
PRODUCER_NAME Produtor
PRODUCT_COMISSION Comissão
PRODUCT_FUNIL Funil infinito
PRODUCT_RPCAFFILIATE RPC Afiliado
PRODUCT_RPCPRODUCER RPC Produtor
PRODUCT_RATING Avaliação do produto
PRODUCT_PRICE Preço do produto
GET /get_showcase_bestsellers

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_showcase_bestsellers \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"PRODUCT_ID":0,"PRODUCT_TITLE":"","PRODUCT_LOGO":"","PRODUCT_RECOVERY":0,"PRODUCER_NAME":"","PRODUCT_COMISSION":"","PRODUCT_FUNIL":0,"PRODUCT_RPCAFFILIATE":"","PRODUCT_RPCPRODUCER":"","PRODUCT_RATING":0,"PRODUCT_PRICE":"1-100"}]}

Produtos recentes

Retorna a lista de produtos recentes.
 

Dados de Retorno:

Campo Descrição
PRODUCT_ID Código do produto
PRODUCT_TITLE Título do produto
PRODUCT_LOGO Logo do produto
PRODUCT_RECOVERY Recuperação de vendas
PRODUCER_NAME Produtor
PRODUCT_COMISSION Comissão
PRODUCT_FUNIL Funil infinito
PRODUCT_RPCAFFILIATE RPC Afiliado
PRODUCT_RPCPRODUCER RPC Produtor
PRODUCT_RATING Avaliação do produto
PRODUCT_PRICE Preço do produto
GET /get_showcase_recent

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_showcase_recent \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"PRODUCT_ID":0,"PRODUCT_TITLE":"","PRODUCT_LOGO":"","PRODUCT_RECOVERY":0,"PRODUCER_NAME":"","PRODUCT_COMISSION":"","PRODUCT_FUNIL":0,"PRODUCT_RPCAFFILIATE":"","PRODUCT_RPCPRODUCER":"","PRODUCT_RATING":0,"PRODUCT_PRICE":"1-100"}]}

Produtos recomendados

Retorna a lista de produtos recomendados.
 

Dados de Retorno:

Campo Descrição
PRODUCT_ID Código do produto
PRODUCT_TITLE Título do produto
PRODUCT_LOGO Logo do produto
PRODUCT_RECOVERY Recuperação de vendas
PRODUCER_NAME Produtor
PRODUCT_COMISSION Comissão
PRODUCT_FUNIL Funil infinito
PRODUCT_RPCAFFILIATE RPC Afiliado
PRODUCT_RPCPRODUCER RPC Produtor
PRODUCT_RATING Avaliação do produto
PRODUCT_PRICE Preço do produto
GET /get_showcase_recommended

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_showcase_recommended \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"PRODUCT_ID":0,"PRODUCT_TITLE":"","PRODUCT_LOGO":"","PRODUCT_RECOVERY":0,"PRODUCER_NAME":"","PRODUCT_COMISSION":"","PRODUCT_FUNIL":0,"PRODUCT_RPCAFFILIATE":"","PRODUCT_RPCPRODUCER":"","PRODUCT_RATING":0,"PRODUCT_PRICE":"1-100"}]}

Produtos Categorizados

Retorna a list de produtos categorizados.
 

Dados de Retorno:

Campo Descrição
PRODUCER_HIGH Lista de divulgados por produtores acima de 300
PRODUCER_LOW Lista de divulgados por produtores até 300
AFFILIATE_HIGH Lista de divulgados por afiliados acima de 300
AFFILIATE_LOW Lista de divulgados por afiliados até 300
PHYSICAL Lista de produtos físicos
GET /get_showcase

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_showcase_categorized \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"PRODUCER_HIGH":[{"PRODUCT_ID":0,"PRODUCT_TITLE":"","PRODUCT_LOGO":"","PRODUCT_RECOVERY":0,"PRODUCER_NAME":"","PRODUCT_COMISSION":"","PRODUCT_FUNIL":0,"PRODUCT_RPCAFFILIATE":"","PRODUCT_RPCPRODUCER":"","PRODUCT_RATING":0,"PRODUCT_PRICE":"1-100"}],"PRODUCER_LOW":[{"PRODUCT_ID":0,"PRODUCT_TITLE":"","PRODUCT_LOGO":"","PRODUCT_RECOVERY":0,"PRODUCER_NAME":"","PRODUCT_COMISSION":"","PRODUCT_FUNIL":0,"PRODUCT_RPCAFFILIATE":"","PRODUCT_RPCPRODUCER":"","PRODUCT_RATING":0,"PRODUCT_PRICE":"1-100"}],"AFFILIATE_HIGH":[{"PRODUCT_ID":0,"PRODUCT_TITLE":"","PRODUCT_LOGO":"","PRODUCT_RECOVERY":0,"PRODUCER_NAME":"","PRODUCT_COMISSION":"","PRODUCT_FUNIL":0,"PRODUCT_RPCAFFILIATE":"","PRODUCT_RPCPRODUCER":"","PRODUCT_RATING":0,"PRODUCT_PRICE":"1-100"}],"AFFILIATE_LOW":[{"PRODUCT_ID":0,"PRODUCT_TITLE":"","PRODUCT_LOGO":"","PRODUCT_RECOVERY":0,"PRODUCER_NAME":"","PRODUCT_COMISSION":"","PRODUCT_FUNIL":0,"PRODUCT_RPCAFFILIATE":"","PRODUCT_RPCPRODUCER":"","PRODUCT_RATING":0,"PRODUCT_PRICE":"1-100"}],"PHYSICAL":[{"PRODUCT_ID":0,"PRODUCT_TITLE":"","PRODUCT_LOGO":"","PRODUCT_RECOVERY":0,"PRODUCER_NAME":"","PRODUCT_COMISSION":"","PRODUCT_FUNIL":0,"PRODUCT_RPCAFFILIATE":"","PRODUCT_RPCPRODUCER":"","PRODUCT_RATING":0,"PRODUCT_PRICE":"1-100"}]}]}

Listar extrato financeiro

Lista os itens do extrato financeiro.

 

Dados de Requesição:

Campo Descrição
DATE_START Data de início do extrato (aaaa-mm-dd)
DATE_END Data de fim do extrato (aaaa-mm-dd)

 

Dados de Retorno:

Campo Descrição
VALUE Valor
DESCRIPTION Descrição
DATE Data
GET /get_financial_statement/{DATE_START}/{DATE_END}

Exemplo da Requisição

$ curl http://my.eduzz.com/api2/get_financial_statement/{DATE_START}/{DATE_END} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Totais do extrato financeiro

Informa os números totais do extrato financeiro.

 

Dados de Retorno:

Campo Descrição
AVAILABLE-TOTAL Ganhos como produtor/afiliado
NOT-AVAILABLE-TOTAL Ganhos não liberados
GET /get_statement_totals

Exemplo da Requisição

$ curl http://my.eduzz.com/api2/get_statement_totals \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Lista de Documentos Fiscais

Retorna sua lista de documentos fiscais.
 

Dados de Requesição:

Campo Descrição
DOCUMENT_TYPE Tipo do documento (DOCS_TO_PRODUCERS, DOCS_FROM_AFFILIATES, DOCS_TO_CLIENTS)
DATE_START Data inicio do filtro
DATE_END Data final do filtro
NAME Filtrar por nome
EMAIL Filtrar por e-mail
SALE_ID Filtrar pelo ID da Fatura
SOURCE_TAXID Filtrar por CNPJ/CPF da Origem
DESTINATION_TAXID Filtrar por CNPJ/CPF de Destino
DOCUMENT_STATUS Status do documento

 

Dados de Retorno:

Campo Descrição
DOCUMENT_ID ID do Documento
DOCUMENT_NAME Nome - Documento
DOCUMENT_STATUS Status do Documento
DOCUMENT_TYPE Tipo do documento (DOCS_TO_PRODUCERS, DOCS_FROM_AFFILIATES, DOCS_TO_CLIENTS)
DOCUMENT_BASEVALUE Valor do Documento
DOCUMENT_EMISSIONDATE Data de emissão do Documento
DOCUMENT_REFERENCEDATE Data de referência do documento
DOCUMENT_PROCESSINGDATE Data que o documento foi processado
DOCUMENT_FILE_STATUS Status do upload do Documento
DOCUMENT_AUXVALUE1 Valor Auxiliar Livre
DOCUMENT_AUXVALUE2 Valor Auxiliar Livre
DOCUMENT_AUXVALUE3 Valor Auxiliar Livre
DOCUMENT_AUXVALUE4 Valor Auxiliar Livre
DOCUMENT_AUXVALUE5 Valor Auxiliar Livre
DOCUMENT_AUXPARAM1 Parametro Auxiliar Livre
DOCUMENT_AUXPARAM2 Parametro Auxiliar Livre
DOCUMENT_AUXPARAM3 Parametro Auxiliar Livre
DOCUMENT_AUXPARAM4 Parametro Auxiliar Livre
DOCUMENT_AUXPARAM5 Parametro Auxiliar Livre
DOCUMENT_TAXBASE Valor base usado para calcular o imposto
DOCUMENT_TAXBASEPERCENT Percentual da base usada para calcular o imposto
DOCUMENT_TAXVALUE Valor do Imposto para este Documento
SOURCE_TAXTYPE Tipo de documento do destino
SOURCE_COMPANY_NAME Razão Social da Origem
SOURCE_DOCUMENT Documento da Origem
SOURCE_IE Inscrição Estadual da Origem
SOURCE_IM Inscrição Municipal da Origem
SOURCE_EMAIL E-mal da Origem
SOURCE_STREET Rua do endereço de Origem
SOURCE_NUMBER Numero do endereço de Origem
SOURCE_COMPLEMENT Complemento do endereço de Origem
SOURCE_DISTRICT Bairro do endereço de Origem
SOURCE_ZIPCODE Cep do endereço de Origem
SOURCE_CITY Cidade de Origem
SOURCE_UF UF da Origem
SOURCE_TEL Telefone da Origem
SOURCE_TEL2 Telefone2 da Origem
SOURCE_CELL Celular da Origem
DESTINATION_COMPANY_NAME Razão Social do Destino
DESTINATION_TAXTYPE Tipo de documento do destino
DESTINATION_TAXID Documento do Destino
DESTINATION_IE Inscrição Estadual do Destino
DESTINATION_IM Inscrição Municipal do Destino
DESTINATION_EMAIL E-mal do Destino
DESTINATION_STREET Rua do endereço de Destino
DESTINATION_NUMBER Numero do endereço de Destino
DESTINATION_COMPLEMENT Complemento do endereço de Destino
DESTINATION_DISTRICT Bairro do endereço de Destino
DESTINATION_ZIPCODE Cep do endereço de Destino
DESTINATION_CITY Cidade de Destino
DESTINATION_UF UF do Destino
DESTINATION_TEL Telefone do Destino
DESTINATION_TEL2 Telefone2 do Destino
DESTINATION_CELL Celular do Destino
DUCUMENT_ITEMS Array de itens do documento

 

Exemplo de Retorno do Documento Item:

Campo Descrição
DOCITEM_ID ID do Item do Documento
DOCITEM_CONTENT_ID Código do Produto ou Serviço na Eduzz
DOCITEM_DESCRIPTION Descrição do Produto ou Serviço na Eduzz
DOCITEM_TAXPRODSERVCODE Código do Produto ou Serviço no órgão oficial
DOCITEM_VALUE Valor deste item específico
DOCITEM_AUXAPARAM1 Parametro Auxiliar Livre
DOCITEM_AUXAPARAM2 Parametro Auxiliar Livre
DOCITEM_TIPOFRETE Tipo do frete
DOCITEM_QTDE Quantidade do produto
DOCITEM_SALE_ID Código da venda ao qual este produto está vinculado
POST /get_taxdocumentlist

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_taxdocumentlist \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"DOCUMENT_TYPE":"","DATE_START":"2019-01-01 00:00:00","DATE_END":"2019-06-15 23:59:59","NAME":"","EMAIL":"","SALE_ID":"","SOURCE_TAXID":"","DESTINATION_TAXID":"","DOCUMENT_STATUS":""}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"DOCUMENT_ID":0,"DOCUMENT_NAME":"","DOCUMENT_STATUS":"","DOCUMENT_TYPE":"","DOCUMENT_BASEVALUE":"","DOCUMENT_EMISSIONDATE":"date","DOCUMENT_REFERENCEDATE":"date","DOCUMENT_PROCESSINGDATE":"date","DOCUMENT_FILE_STATUS":"","DOCUMENT_AUXVALUE1":"","DOCUMENT_AUXVALUE2":"","DOCUMENT_AUXVALUE3":"","DOCUMENT_AUXVALUE4":"","DOCUMENT_AUXVALUE5":"","DOCUMENT_AUXPARAM1":"","DOCUMENT_AUXPARAM2":"","DOCUMENT_AUXPARAM3":"","DOCUMENT_AUXPARAM4":"","DOCUMENT_AUXPARAM5":"","DOCUMENT_TAXBASE":"","DOCUMENT_TAXBASEPERCENT":"","DOCUMENT_TAXVALUE":"","SOURCE_TAXTYPE":"","SOURCE_COMPANY_NAME":"","SOURCE_DOCUMENT":"","SOURCE_IE":"","SOURCE_IM":"","SOURCE_EMAIL":"","SOURCE_STREET":"","SOURCE_NUMBER":"","SOURCE_COMPLEMENT":"","SOURCE_DISTRICT":"","SOURCE_ZIPCODE":"","SOURCE_CITY":"","SOURCE_UF":"","SOURCE_TEL":"","SOURCE_TEL2":"","SOURCE_CELL":"","DESTINATION_COMPANY_NAME":"","DESTINATION_TAXTYPE":"","DESTINATION_TAXID":"","DESTINATION_IE":"","DESTINATION_IM":"","DESTINATION_EMAIL":"","DESTINATION_STREET":"","DESTINATION_NUMBER":"","DESTINATION_COMPLEMENT":"","DESTINATION_DISTRICT":"","DESTINATION_ZIPCODE":"","DESTINATION_CITY":"","DESTINATION_UF":"","DESTINATION_TEL":"","DESTINATION_TEL2":"","DESTINATION_CELL":"","DUCUMENT_ITEMS":[{"DOCITEM_ID":0,"DOCITEM_CONTENT_ID":"","DOCITEM_DESCRIPTION":"","DOCITEM_TAXPRODSERVCODE":"","DOCITEM_VALUE":"","DOCITEM_AUXAPARAM1":"","DOCITEM_AUXAPARAM2":"","DOCITEM_TIPOFRETE":"","DOCITEM_QTDE":"","DOCITEM_SALE_ID":0}]}]}

Documento Fiscal

Retorna informações do documento fiscal.
O ID do documento deve ser informado no campo DOCUMENT_ID no endereço da consulta.
 

Dados de Retorno:

Campo Descrição
DOCUMENT_ID ID do Documento
DOCUMENT_NAME Nome - Documento
DOCUMENT_STATUS Status do Documento
DOCUMENT_TYPE Tipo do documento (DOCS_TO_PRODUCERS, DOCS_FROM_AFFILIATES, DOCS_TO_CLIENTS)
DOCUMENT_BASEVALUE Valor do Documento
DOCUMENT_EMISSIONDATE Data de emissão do Documento
DOCUMENT_REFERENCEDATE Data de referência do documento
DOCUMENT_PROCESSINGDATE Data que o documento foi processado
DOCUMENT_FILE_STATUS Status do upload do Documento
DOCUMENT_AUXVALUE1 Valor Auxiliar Livre
DOCUMENT_AUXVALUE2 Valor Auxiliar Livre
DOCUMENT_AUXVALUE3 Valor Auxiliar Livre
DOCUMENT_AUXVALUE4 Valor Auxiliar Livre
DOCUMENT_AUXVALUE5 Valor Auxiliar Livre
DOCUMENT_AUXPARAM1 Parametro Auxiliar Livre
DOCUMENT_AUXPARAM2 Parametro Auxiliar Livre
DOCUMENT_AUXPARAM3 Parametro Auxiliar Livre
DOCUMENT_AUXPARAM4 Parametro Auxiliar Livre
DOCUMENT_AUXPARAM5 Parametro Auxiliar Livre
DOCUMENT_TAXBASE Valor base usado para calcular o imposto
DOCUMENT_TAXBASEPERCENT Percentual da base usada para calcular o imposto
DOCUMENT_TAXVALUE Valor do Imposto para este Documento
SOURCE_TAXTYPE Tipo de documento do destino
SOURCE_COMPANY_NAME Razão Social da Origem
SOURCE_DOCUMENT Documento da Origem
SOURCE_IE Inscrição Estadual da Origem
SOURCE_IM Inscrição Municipal da Origem
SOURCE_EMAIL E-mal da Origem
SOURCE_STREET Rua do endereço de Origem
SOURCE_NUMBER Numero do endereço de Origem
SOURCE_COMPLEMENT Complemento do endereço de Origem
SOURCE_DISTRICT Bairro do endereço de Origem
SOURCE_ZIPCODE Cep do endereço de Origem
SOURCE_CITY Cidade de Origem
SOURCE_UF UF da Origem
SOURCE_TEL Telefone da Origem
SOURCE_TEL2 Telefone2 da Origem
SOURCE_CELL Celular da Origem
DESTINATION_COMPANY_NAME Razão Social do Destino
DESTINATION_TAXTYPE Tipo de documento do destino
DESTINATION_TAXID Documento do Destino
DESTINATION_IE Inscrição Estadual do Destino
DESTINATION_IM Inscrição Municipal do Destino
DESTINATION_EMAIL E-mal do Destino
DESTINATION_STREET Rua do endereço de Destino
DESTINATION_NUMBER Numero do endereço de Destino
DESTINATION_COMPLEMENT Complemento do endereço de Destino
DESTINATION_DISTRICT Bairro do endereço de Destino
DESTINATION_ZIPCODE Cep do endereço de Destino
DESTINATION_CITY Cidade de Destino
DESTINATION_UF UF do Destino
DESTINATION_TEL Telefone do Destino
DESTINATION_TEL2 Telefone2 do Destino
DESTINATION_CELL Celular do Destino
DUCUMENT_ITEMS Array de itens do documento
GET /get_taxdocument/{DOCUMENT_ID}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":{"DOCUMENT_ID":0,"DOCUMENT_NAME":"","DOCUMENT_STATUS":"","DOCUMENT_TYPE":"","DOCUMENT_BASEVALUE":"","DOCUMENT_EMISSIONDATE":"date","DOCUMENT_REFERENCEDATE":"date","DOCUMENT_PROCESSINGDATE":"date","DOCUMENT_FILE_STATUS":"","DOCUMENT_AUXVALUE1":"","DOCUMENT_AUXVALUE2":"","DOCUMENT_AUXVALUE3":"","DOCUMENT_AUXVALUE4":"","DOCUMENT_AUXVALUE5":"","DOCUMENT_AUXPARAM1":"","DOCUMENT_AUXPARAM2":"","DOCUMENT_AUXPARAM3":"","DOCUMENT_AUXPARAM4":"","DOCUMENT_AUXPARAM5":"","DOCUMENT_TAXBASE":"","DOCUMENT_TAXBASEPERCENT":"","DOCUMENT_TAXVALUE":"","SOURCE_TAXTYPE":"","SOURCE_COMPANY_NAME":"","SOURCE_DOCUMENT":"","SOURCE_IE":"","SOURCE_IM":"","SOURCE_EMAIL":"","SOURCE_STREET":"","SOURCE_NUMBER":"","SOURCE_COMPLEMENT":"","SOURCE_DISTRICT":"","SOURCE_ZIPCODE":"","SOURCE_CITY":"","SOURCE_UF":"","SOURCE_TEL":"","SOURCE_TEL2":"","SOURCE_CELL":"","DESTINATION_COMPANY_NAME":"","DESTINATION_TAXTYPE":"","DESTINATION_TAXID":"","DESTINATION_IE":"","DESTINATION_IM":"","DESTINATION_EMAIL":"","DESTINATION_STREET":"","DESTINATION_NUMBER":"","DESTINATION_COMPLEMENT":"","DESTINATION_DISTRICT":"","DESTINATION_ZIPCODE":"","DESTINATION_CITY":"","DESTINATION_UF":"","DESTINATION_TEL":"","DESTINATION_TEL2":"","DESTINATION_CELL":"","DUCUMENT_ITEMS":[{"DOCITEM_ID":0,"DOCITEM_CONTENT_ID":"","DOCITEM_DESCRIPTION":"","DOCITEM_TAXPRODSERVCODE":"","DOCITEM_VALUE":"","DOCITEM_AUXAPARAM1":"","DOCITEM_AUXAPARAM2":"","DOCITEM_TIPOFRETE":"","DOCITEM_QTDE":"","DOCITEM_SALE_ID":0}]}}

Enviar arquivo do Documento

Envia arquivo do documento fiscal.
O ID do documento deve ser informado no campo DOCUMENT_ID no endereço da consulta.
 

Dados de Retorno:

Campo Descrição
FILEURL URL do arquivo.
GET /upload_documentfile/{DOCUMENT_ID}

Exemplo da Requisição

$ curl http://my.eduzz.com/api2/upload_documentfile/{DOCUMENT_ID} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"FILEURL":"http:\/\/{File URL}"}

Alterar Status do Documento

Altera o Status do documento fiscal.
O ID do documento deve ser informado no campo DOCUMENT_ID no endereço da consulta.
 

Dados de Requesição:

Campo Descrição
DOCUMENT_STATUS Novo

 

Opções de Status:

Campo Descrição
DOCUMENT_STATUS_NEW Novo
DOCUMENT_STATUS_PENDING Pendente
DOCUMENT_STATUS_DOCWAITING Aguardando documento
DOCUMENT_STATUS_CANCELLED Cancelado
DOCUMENT_STATUS_PROCESSING Em Processamento
DOCUMENT_STATUS_PROCESSED Processado
DOCUMENT_STATUS_APPROVED Aprovado
DOCUMENT_STATUS_FILECREATED Arquivo Gerado
GET /change_documentstatus/{DOCUMENT_ID}

Exemplo da Requisição

$ curl http://my.eduzz.com/api2/change_documentstatus/{DOCUMENT_ID} \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"DOCUMENT_STATUS":"DOCUMENT_STATUS_NEW"}

Dados do Usuário

Retorna seus dados de cadastro na Eduzz
 

Dados de Retorno:

Campo Descrição
USER_ID ID do usuario
COMPANY_NAME Nome Completo / Razão Social
FANTASY Nome Fantasia
TAXID CPF/CNPJ
DATE_USER_CREATE Data de cadastro
EMAIL E-mail
TELEPHONE Telefone
TELEPHONE2 Telefone 2
CELLPHONE Celular
ADDRESS_STREET Rua do endereço
ADDRESS_NUMBER Numero do endereço
ADDRESS_COMPLEMENT Complemento do endereço
ADDRESS_CEP CEP do endereço
ADDRESS_DISTRICT Barro do endereço
ABOUT Sobre
PHOTO Foto
CONTACT_PHONE Telefone de contato
CONTACT_EMAIL E-mail de contato
FACEBOOK Facebook
SKYPE Skype
GET /get_me

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_me \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":{"USER_ID":0,"COMPANY_NAME":"","FANTASY":"","TAXID":"","DATE_USER_CREATE":"","EMAIL":"","TELEPHONE":"","TELEPHONE2":"","CELLPHONE":"","ADDRESS_STREET":"","ADDRESS_NUMBER":"","ADDRESS_COMPLEMENT":"","ADDRESS_CEP":"","ADDRESS_DISTRICT":"","ABOUT":"","PHOTO":"","CONTACT_PHONE":"","CONTACT_EMAIL":"","FACEBOOK":"","SKYPE":""}}

Alterar dados

Altera seus dados de cadastro na Eduzz
 

Descrição dos campos:

Campo Descrição
USER_ID ID do usuario
COMPANY_NAME Nome Completo / Razão Social
FANTASY Nome Fantasia
TAXID CPF/CNPJ
DATE_USER_CREATE Data de cadastro
EMAIL E-mail
TELEPHONE Telefone
TELEPHONE2 Telefone 2
CELLPHONE Celular
ADDRESS_STREET Rua do endereço
ADDRESS_NUMBER Numero do endereço
ADDRESS_COMPLEMENT Complemento do endereço
ADDRESS_CEP CEP do endereço
ADDRESS_DISTRICT Barro do endereço
ABOUT Sobre
PHOTO Foto
CONTACT_PHONE Telefone de contato
CONTACT_EMAIL E-mail de contato
FACEBOOK Facebook
SKYPE Skype
GET /set_me

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/set_me \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"FANTASY":"","TAXID":"","TELEPHONE":"","TELEPHONE2":"","CELLPHONE":"","ADDRESS_STREET":"","ADDRESS_NUMBER":"","ADDRESS_COMPLEMENT":"","ADDRESS_CEP":"","ADDRESS_DISTRICT":"","ABOUT":"","PHOTO":"","CONTACT_PHONE":"","CONTACT_EMAIL":"","FACEBOOK":"","SKYPE":""}

Por Email

Retorna os dados de um usuário pelo e-mail.
Para utlizar esta função, por favor solicite através do e-mail suporte@eduzz.com
 

Dados de Retorno:

Campo Descrição
USER_ID ID do usuario
COMPANY_NAME Nome Completo / Razão Social
FANTASY Nome Fantasia
TAXID CPF/CNPJ
DATE_USER_CREATE Data de cadastro
EMAIL E-mail
TELEPHONE Telefone
TELEPHONE2 Telefone 2
CELLPHONE Celular
ADDRESS_STREET Rua do endereço
ADDRESS_NUMBER Numero do endereço
ADDRESS_COMPLEMENT Complemento do endereço
ADDRESS_CEP CEP do endereço
ADDRESS_DISTRICT Barro do endereço
ABOUT Sobre
PHOTO Foto
CONTACT_PHONE Telefone de contato
CONTACT_EMAIL E-mail de contato
FACEBOOK Facebook
SKYPE Skype
GET /get_user_byemail

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_user_byemail \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":{"USER_ID":0,"COMPANY_NAME":"","FANTASY":"","TAXID":"","DATE_USER_CREATE":"","EMAIL":"","TELEPHONE":"","TELEPHONE2":"","CELLPHONE":"","ADDRESS_STREET":"","ADDRESS_NUMBER":"","ADDRESS_COMPLEMENT":"","ADDRESS_CEP":"","ADDRESS_DISTRICT":"","ABOUT":"","PHOTO":"","CONTACT_PHONE":"","CONTACT_EMAIL":"","FACEBOOK":"","SKYPE":""}}

Solicitar Transferência Bancária

Solicita a transferência do saldo financeiro disponível na Eduzz para uma conta bancária.

 

Descrição dos campos:

Campo Descrição
VALUE Valor da Solicitação de Transferência
BANK_ACCOUNT_ID ID da conta bancária deste usuário. Obtenha requisitando o /list_fund_transfer_methods da api
POST /request_bank_transfer

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/request_bank_transfer \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"VALUE":"","BANK_ACCOUNT_ID":0}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[]}

Listar Contas bancárias

Lista as contas bancárias ativas do usuário para transferir seus ganhos na Eduzz.

 

Dados de Retorno:

Campo Descrição
BANK_ACCOUNT_ID ID da conta bancária deste usuário
BANK_NUMBER Número do Banco
BANK_NAME Nome do Banco
ACCOUNT_TYPE Tipo da Conta (Conta Corrente ou Poupança)
AGENCY_NUMBER Número da Agência
AGENCY_DIGIT Dígito da Agência
ACCOUNT_NUMBER Número da Conta
ACCOUNT_DIGIT Dígito da Conta
ACCOUNT_HOLDER_NAME Nome do Titular da Conta
ACCOUNT_HOLDER_TAXID CPF/CNPJ do Titular da Conta
ACCOUNT_HOLDER_TYPE Tipo do Titular da Conta (Pessoa Física ou Jurídica
GET /list_fund_transfer_methods

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/list_fund_transfer_methods \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"BANK_ACCOUNT_ID":0,"BANK_NUMBER":0,"BANK_NAME":"","ACCOUNT_TYPE":"","AGENCY_NUMBER":"","AGENCY_DIGIT":"","ACCOUNT_NUMBER":"","ACCOUNT_DIGIT":"","ACCOUNT_HOLDER_NAME":"","ACCOUNT_HOLDER_TAXID":"","ACCOUNT_HOLDER_TYPE":""}]}

Valor Disponível para Transferência

Obtém o Valor disponível para Transferência bancária dos ganhos.

 

Dados de Retorno:

Campo Descrição
VALUE_AVAILABLE Valor Disponível para Transferência (Já abatido encargos com transferência (R$ 9,00) + Lançamentos negativos futuros no Extrato)
GET /value_available_for_banktransfer

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/value_available_for_banktransfer \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"VALUE_AVAILABLE":0}]}

Listar contatos do Chat

Lista os contatos que o usuário pode enviar mensagens.

 

Dados de requisição:

Campo Descrição
SEARCH Pesquisa com o nome do contato desejado.
POST /get_chat_contacts

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_chat_contacts \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"SEARCH":""}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"USER_ID":0,"USER_NAME":"","USER_PICTURE":"false","BADGE":{"BADGE_IMAGE":{"IMG_URL":"","HINT":""}}}]}

Listar chats ativos

Lista os chats ativos do usuário.

 

Dados de requisição:

POST /get_chat_actives

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_chat_actives \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9"

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"CHAT_ID":0,"USER_PICTURE_TO":"","USER_PICTURE_FROM":"","DATETIME":"","USER_ID_FROM":"","USER_ID_TO":"","USER_NAME_TO":"","USER_NAME_FROM":"","LAST_MESSAGE":"","LAST_MESSAGE_DATETIME":""}]}

Listas as mensagens de uma conversa

Listas as mensagens de uma conversa.

 

Dados de requisição:

Campo Descrição
CHAT_ID ID da conversa da que está se buscando as mensagens
USER_ID_TO ID do cliente destinatário da conversa
GET /get_conversation_messages

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/get_conversation_messages \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"CHAT_ID":0,"USER_ID_TO":0}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[{"FROM_ME":true,"USER_PICTURE_TO":"","TEXT":"","SENDER_NAME":"","DATE_CREATION":"2019-06-15 23:59:59","USER_ID_TO":0,"USER_ID_FROM":0}]}

Adicionar Mensagem Ao Chat

Adiciona uma nova mensagem a uma conversa.

 

Dados de requisição:

Campo Descrição
CHAT_ID ID da conversa da que está sendo adicionada a mensagem
TEXT Texto que será enviado
USER_ID_TO ID do cliente destinatário da conversa
GET /add_chat_message

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/add_chat_message \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"CHAT_ID":0,"TEXT":"","USER_ID_TO":0}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[]}

Enviar mensagem para um grupo

Enviar mensagem para um grupo de pessoas.

 

Dados de requisição:

Campo Descrição
USERS_IDS IDs dos usuários para enviar as mensagens
TEXT Texto da mensagem a ser enviada
SEND_EMAIL Se deve também enviar um e-mail para os destinatários
POST /add_chat_message_all

Exemplo de Requisição

$ curl http://my.eduzz.com/api2/add_chat_message_all \
    -H "PublicKey: 123123" \
    -H "APIKey: A1S9F9" \
    {"USERS_IDS":[],"TEXT":"","SEND_EMAIL":false}

Exemplo de Resposta

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{"STATUS":"SUCCESS","MESSAGE":"","data":[]}