API de criação de ofertas

POST https://api.offer18.com/api/m/offers

🔗 Clique para testar a API de criação da oferta

Parâmetros comuns

Consulta	Tipo	Descrição
mid	Inteiro	ID da conta da rede
api-key	String	Chave de API da rede
secret-key	String	Chave secreta da rede

Ação

Consulta	Tipo	Descrição
action	String	Valores permitidos: create / update / delete
offer_id	Inteiro	Obrigatório na atualização e exclusão da oferta

---

Campos

Corpo	Tipo	Descrição
offer_name	String	Nome da campanha
advertiser_id	Inteiro	ID do anunciante
offer_url	URL	URL da campanha
external_offer_id	String	ID externo da campanha (se houver)
app_id	String	ID do app (se houver)
logo	URL	URL do logo da campanha
category	String	Categoria da campanha
preview_url	URL	URL de pré-visualização da campanha
currency	String	Moeda da oferta 🔗 Ver moedas
price_advertiser	Decimal	Preço dado pelo anunciante para a campanha
price_affiliate	Decimal	Preço dado ao afiliado para a campanha
model_advertiser	String	Modelo do anunciante da campanha 🔗 Ver modelos
model_affiliate	String	Modelo do anunciante da campanha 🔗 Ver modelos
hide_affiliate_payout	Inteiro	Valores permitidos 1: Para ocultar o pagamento do afiliado
start_datetime	Timestamp UTC	Data/hora de início (YYYY-MM-DD HH:MM:SS)
end_datetime	Timestamp UTC	Data/hora de término (YYYY-MM-DD HH:MM:SS )
visibility	String	Valores permitidos: public, permission, private
status	String	Valores permitidos: approve, pending
deep_links	Inteiro	Valores permitidos 1: Para habilitar deeplinks nas ofertas
offer_terms	String	Termos da campanha
offer_kpi	String	Termos de KPI da campanha
private_note	String	Notas privadas na campanha
imps_url	URL	URL de impressão
landing_page_id_1	Inteiro	Caso o usuário queira atualizar a landing page existente
landing_page_name_1	String	Nome da primeira landing page
landing_page_url_1	URL	URL da primeira landing page da campanha
landing_page_id_2	Inteiro	Caso o usuário queira atualizar a landing page existente
landing_page_name_2	String	Nome da segunda landing page
landing_page_url_2	URL	URL da segunda landing page da campanha
creatives	URL	URL dos criativos da campanha
fallback	boolean	Valores permitidos: 1: Para habilitar o fallback
fallback_offer_id	Inteiro	ID da oferta de fallback
fallback_url	URL	URL do fallback
fraud_conv_speed	Inteiro	Tempo em segundos
proxy_block	Inteiro	Valores permitidos: 1: Para bloquear proxies
blank_ref_block	Inteiro	Valores permitidos: 1: Para bloquear referência em branco
hide_referral	Inteiro	Valores permitidos: 1: Para ocultar a referência
assign_affiliates	Inteiro	Atribuir afiliados a esta campanha (valores separados por vírgula)
capping_rule_id	Inteiro	Caso o usuário queira atualizar a regra de capping existente
capping[0][capping_rule_name]	String	Nome da regra de capping
capping[0][capping_rule_type]	String	Tipo de regra de capping 1. advertiser_capping 2. affiliate_capping
capping[0][capping_timezone]	Carimbo de data/hora	Fuso horário do capping
capping[0][capping_events]	String	Eventos de capping
capping[0][capping_type]	String	Tipo de capping 1. gross_conversions 2. approved_conversions 3. gross_revenue 4. approved_revenue 5. gross_payout 6. approved_payout 7. gross_clicks 8. approved_clicks
capping[0][capping_period]	String	Período de capping 1. diário 2. semanal 3. mensal 4. por hora
capping[0][capping_value]	Inteiro	Valor de capping
capping[0][overcap_action]	String	Ação ao exceder o limite 1. stop 2. fallback 3. fallback_conversion_accept 4. conversion_accept 5. conversion_reject 6. conversion_pending
capping[0][capping_notification_email]	Stirng	E-mail de notificação de capping
capping[0][capping_affiliate_visibility]	Inteiro	1: Para mostrar a regra de capping ao afiliado
capping[0][capping_affiliate_id]	Stirng	IDs de afiliado (separados por vírgula)
targeting_rule_id	Inteiro	Caso o usuário queira atualizar a regra de segmentação existente
target_country	String	Permitir país específico 🔗 Ver países
block_country	String	Bloquear país específico 🔗 Ver países
target_os	String	Permitir sistema operacional específico 🔗 Ver SO
block_os	String	Bloquear sistema operacional específico 🔗 Ver SO
target_device	String	Permitir dispositivos específicos 🔗 Ver dispositivos
block_device	String	Bloquear dispositivos específicos 🔗 Ver dispositivos
target_browser	String	Permitir navegador específico 🔗 Ver navegadores
block_browser	String	Bloquear navegador específico 🔗 Ver navegadores
target_isp	String	Permitir ISP específico
block_isp	String	Bloquear ISP específico
events[0][event_name]	String	Nome do evento
events[0][event_token]	String	Token do evento
capping_conversion_period	String	Obsoleto
capping_budget	Inteiro	Obsoleto
capping_conversion	Inteiro	Obsoleto
capping_budget_period	String	Obsoleto

Regras de capping (instruções)

1. Se você quiser definir várias regras de capping, pode fazer isso atribuindo regras a números diferentes Exemplo 1: capping[1][capping_rule_name] capping[1][capping_rule_type] Exemplo 2: capping[2][capping_rule_name] capping[2][capping_rule_type]

2. Se você quiser atualizar uma regra de capping existente, você deve enviar capping_rule_id em a solicitação da API junto com os novos dados para 0(Zero) número Exemplo: capping[0][capping_rule_name] capping[0][capping_rule_type]

Eventos (instruções)

1. Se você quiser criar vários eventos, pode fazer isso atribuindo eventos a números diferentes Exemplo 1: events[1][event_name] events[1][event_token] Exemplo 2: events[2][event_name] events[2][event_token]

---

Exemplo de solicitação da API

Criação da oferta

Resposta da API

{
    "status": "200",
    "response": "offer_created_successfully",
    "offer_id": 000012    
}

Atualização da oferta

Resposta da API

{
    "status": "200",
    "response": "offer_updated_successfully",
    "offer_id": "000001"
}

---

Para interações seguras, sempre chame a API pelo lado do servidor.