Antes de começar
API para ofertas
A API do Affise fornece muitos métodos para trabalhar com ofertas: você pode obter informações ou adicionar/alterar/excluir. Por meio da API, você pode gerenciar suas ofertas, permitindo que os afiliados adicionem uma ou mais regras de limite. Neste artigo, você encontrará exemplos das solicitações (métodos) de API mais populares para ofertas com exemplos de cURL e exemplos da resposta.
Lista de ofertas
Use esse método para obter a lista de ofertas de acordo com suas propriedades, que você pode indicar em sua solicitação de API.
O método: GET /3.0/offers.
A solicitação para obter ofertas com o status Active (Ativo):
https://api-rocketcompany.affise.com/3.0/offers?api-key=4sdf87fsdfd8723lkjhrn324&status[]=active
Adicionar uma oferta
Use esse método para adicionar uma oferta ao painel de administração. No documento da API, você vê parâmetros gerais, bem como parâmetros do tipo de matriz para:
pagamentos
páginas de destino
limites
níveis de comissão
grupos de segmentação
URLs de rastreamento adicionais
Estrutura do sistema operacional
Criativos em HTML
cronograma de ofertas
Todos esses tipos de dados têm parâmetros obrigatórios:
um parâmetro principal para cada tipo
parâmetro(s) obrigatório(s) dentro de cada matriz (marcado(s) com * no documento da API)
A lista de parâmetros principais para cada tipo de dados:
pagamentos: para pagamentos
landing pages: para páginas de aterrissagem e pré-páginas de aterrissagem
caps: para caps
commission_tiers: para níveis de comissão
targeting: para grupos de targeting
schedule: para o cronograma da oferta
creativesHtml: para criativos em HTML
Os parâmetros obrigatórios para criar uma oferta são:
title
anunciante
url
pagamentos
Se você não souber quais valores adicionar (por exemplo, códigos ISO para países), use os métodos aqui e aqui, que ajudarão a obter a lista de valores disponíveis.
O método: POST /3.0/admin/offer
A solicitação cURL para adicionar uma oferta com as seguintes propriedades:
o status Active (Ativo).
O nível de privacidade Privado.
a caixa de seleção CPI selecionada.
a nota.
um grupo de segmentação geral para França, Alemanha e Itália, para Android >= 6.0.0.
um pagamento geral para os mesmos países, o tipo fixo de pagamento em USD.
uma regra de limite para 1000 conversões para o período = mês, meta = todos, afiliados = todos.
duas páginas de destino.
curl --request POST \ --url https://api-rocketcompany.affise.com/3.0/admin/offer \ --header 'api-key: 4sdf87fsdfd8723lkjhrn324' \ --header 'content-type: application/x-www-form-urlencoded' \ --data 'title=New Offer' \ --data advertiser=62fcd7ae7a3ccd7eacd7e4eb \ --data 'url=http://new-tracking-link.network.com?clickid={clickid}' \ --data status=active \ --data privacy=private \ --data is_cpi=1 \ --data 'notes=Esta é a mais nova oferta' \ --data 'targeting[0][country][allow][0]=FR' \ --data 'targeting[0][country][allow][1]=DE' \ --data 'targeting[0][country][allow][2]=IT' \ --data 'targeting[0][os][allow][0][name]=Android' \ --data 'targeting[0][os][allow][0][comparison]=GTE' \ --data 'targeting[0][os][allow][0][version]=6.0.0' \ --data 'payments[0][countries][0]=FR' \ --data 'payments[0][countries][1]=DE' \ --data 'payments[0][countries][2]=IT' \ --data 'payments[0][currency]=USD' \ --data 'payments[0][type]=fixed' \ --data 'caps[0][period]=month' \ --data 'caps[0][type]=conversions' \ --data 'caps[0][value]=1000' \ --data 'caps[0][goal_type]=all' \ --data 'caps[0][affiliate_type]=all' \ --data 'landings[0][title]=Dating online' \ --data 'landings[0][url]=http://new-tracking-link.network.com?clickid={clickid}&sub1=online' \ --data 'landings[0][url_preview]=http://new-tracking-link.network.com/online' \ --data 'landings[1][title]=Dating offline' \ --data 'landings[1][url]=http://new-tracking-link.network.com?clickid={clickid}&sub1=offline' \ --data 'landings[1][url_preview]=http://new-tracking-link.network.com/offline'⚠️ Certifique-se de atender a todos os requisitos do tipo de matriz de dados, inclusive colchetes e numeração.
Adicionar uma oferta com logotipo ou criativos
Use esse método para adicionar uma oferta com um logotipo ou um anúncio. Além dos parâmetros obrigatórios mencionados anteriormente, você pode adicionar os seguintes:
creativeFiles
creativeUrls
creativeDownloads
creativesHtml
creativeAssets
creativeFileTitles
creativeUrlTitles
creativeDownloadTitles
logotipo
⚠️ Se você criar uma oferta manualmente por meio da API e quiser adicionar um logotipo ou arquivos/downloads criativos, certifique-se de usar o seguinte cabeçalho content-type: multipart/form-data.
A solicitação pode ter a seguinte aparência:
Você pode ver uma demonstração de como adicionar um arquivo com um logotipo:
A solicitação cURL para a criação da oferta com logotipo e criativos:
curl --location --request POST 'https://api-rocketcompany.affise.com/3.0/admin/offer' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'Content-Type: multipart/form-data' \--header 'api-key: bf09c801ff9b95b14ac8e17d6e4904b6' \--form 'title=OFFER WITH LOGO AND CREATIVES' \--form 'advertiser=5e39279bac611cda7e5765ab' \--form 'url=https://track.gjane.com/hc/click?afclick={clickid}&afpid={pid}&afoffer={offer_id}' \--form 'logo=@/C:/Users/37525/Downloads/api.png' \--form 'creativeFiles[0]=@/C:/Users/37525/Downloads/api.png' \--form 'creativeUrls[1]=https://google.drive' \--form 'creativeDownloads=https://google.drive/download' \Editar uma oferta
Use esse método para editar uma oferta: todas as configurações ou apenas uma parte da oferta. Recomendamos a leitura do artigo sobre a edição do tipo de matriz de dados antes de usar esse método.
O método: POST /3.0/admin/offer/{ID}
A solicitação cURL para editar um grupo de segmentação na mesma oferta, que é usada como exemplo para adicionar a oferta. No exemplo, o seguinte foi alterado:
França, Alemanha e Itália foram substituídas por Islândia e Irlanda.
a versão do sistema operacional foi alterada para 7.0.0.
a ferramenta de proxy antifraude foi ativada.
curl --request POST \ --url https://api-rocketcompany.affise.com/3.0/admin/offer/1441594 \ --header 'api-key: 4sdf87fsdfd8723lkjhrn324' \ --header 'content-type: application/x-www-form-urlencoded' \ --data 'targeting[0][country][allow][0]=IS' \ --data 'targeting[0][country][allow][1]=IE' \ --data 'targeting[0][block_proxy]=1' \ --data 'targeting[0][os][allow][0][name]=Android' \ --data 'targeting[0][os][allow][0][comparison]=GTE' \ --data 'targeting[0][os][allow][0][version]=7.0.0' \ --data =
⚠️ Certifique-se de atender a todos os requisitos do tipo de matriz de dados, inclusive colchetes e numeração.
Habilitar afiliados
Use esse método para permitir que seu afiliado trabalhe com a oferta. O método é relevante somente se o nível de privacidade da oferta for Pré-moderação ou Privado.
O método: POST /3.0/offer/enable-affiliate.
A solicitação cURL para habilitar o afiliado nº 2:
curl --request POST \ --url https://api-rocketcompany.affise.com/3.0/offer/enable-affiliate \ --header 'api-key: 4sdf87fsdfd8723lkjhrn324' \ --header 'content-type: application/x-www-form-urlencoded' \ --data offer_id=1441594 \ --data pid=2
Desativar afiliados
Use esse método para permitir que seu afiliado trabalhe com a oferta. O método é relevante para ofertas com todos os níveis de privacidade.
O método: POST /3.0/offer/enable-affiliate.
A solicitação cURL para a desativação do afiliado #2:
curl --request POST \ --url https://api-rocketcompany.affise.com/3.0/offer/disable-affiliate \ --header 'api-key: 4sdf87fsdfd8723lkjhrn324' \ --header 'content-type: application/x-www-form-urlencoded' \ --data offer_id=1441594 \ --data pid=2
A lista de afiliados desativados/ativados
Use esse método para obter a lista de afiliados que podem ou não trabalhar com uma determinada oferta.
O método: GET /3.1/offers/{ID}/privacy.
A solicitação:
https://api-rocketcompany.affise.com/3.1/offers/1441594/privacy?api-key=4sdf87fsdfd8723lkjhrn324
Atualizar o status das ofertas
Use esse método para alterar em massa o status das ofertas.
O método: POST /3.0/admin/offer/mass-update.
A solicitação cURL para alterar os status de três ofertas para Pausado:
curl --request POST \ --url https://api-rocketcompany.affise.com/3.0/admin/offer/mass-update \ --header 'api-: 4sdf87fsdfd8723lkjhrn324' \ --header 'content-type: application/x-www-form-urlencoded' \ --data 'offer_id[0]=1441594' \ --data 'offer_id[1]=1441528' \ --data 'offer_id[2]=1441527' \ --data status=suspended
Entre em contato com a equipe de Suporte ao Cliente da Affise sobre todas as questões levantadas por meio do e-mail: [email protected].