API de Criação de Oferta

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

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

Parâmetros Comuns

Query	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

Query	Tipo	Descrição
type	String	Valores Permitidos: create / update
oid	Inteiro	Obrigatório na Atualizaçã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 visualização da Campanha
currency	String	Moeda da Oferta 🔗 Ver Moedas
price_advertiser	Decimal	Preço dado pelo Anunciante pela Campanha
price_affiliate	Decimal	Preço dado ao Afiliado pela 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 ao Afiliado
start_datetime	Timestamp UTC	Data/hora de início (AAAA-MM-DD HH:MM:SS)
end_datetime	Timestamp UTC	Data/hora de término (AAAA-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_name_1	String	Nome da primeira landing page
landing_page_url_1	URL	URL da primeira landing page da Campanha
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 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 indicação
assign_affiliates	Inteiro	Atribuir Afiliados a esta Campanha (Valores separados por vírgula)
capping_rule_id	String	Caso o usuário queira Atualizar 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]	Timestamp	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. daily 2. weekly 3. monthly 4. hourly
capping[0][capping_value]	Inteiro	Valor de Capping
capping[0][overcap_action]	String	Ação de Overcap 1. stop 2. fallback 3. fallback_conversion_accept 4. conversion_accept 5. conversion_reject 6. conversion_pending
capping[0][capping_notification_email]	Stirng	Email de Notificação de Capping
capping[0][capping_affiliate_visibility]	Inteiro	1: Mostrar Regra de Capping para o afiliado
capping[0][capping_affiliate_id]	Stirng	IDs de Afiliado (separados por vírgula)
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 para o evento
capping_conversion_period	String	Depreciado
capping_budget	Inteiro	Depreciado
capping_conversion	Inteiro	Depreciado
capping_budget_period	String	Depreciado

Regras de Capping (Instruções)

1. Se você quiser definir várias regras de capping, pode fazê-lo 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 postar capping_rule_id em Solicitação de API junto com 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 múltiplos eventos, pode fazê-lo 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 Requisição API

Criação de Oferta

Resposta da API

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

Atualização de Oferta

Resposta da API

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

---

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