Antes de empezar
API para ofertas
La API de Affise le proporciona muchos métodos para trabajar con ofertas: puede obtener información o añadir/modificar/eliminarla. A través de la API puede gestionar sus ofertas desde permitir a los afiliados añadir una o más reglas de límites. En este artículo, encontrará ejemplos de las solicitudes (métodos) de API más populares para ofertas con ejemplos cURL y ejemplos de la respuesta.
Lista de ofertas
Utilice este método para obtener la lista de ofertas según sus propiedades, que puede indicar en su petición API.
El método: GET /3.0/ofertas.
La petición para obtener ofertas con el estado Activo:
https://api-rocketcompany.affise.com/3.0/offers?api-key=4sdf87fsdfd8723lkjhrn324&status[]=activa
Añadir una oferta
Utilice este método para añadir una oferta al panel de administración. En el documento de la API, puede ver los parámetros generales así como los parámetros de tipo array para:
pagos
páginas de destino
topes
niveles de comisión
grupos de segmentación
URL de seguimiento adicionales
Estructura del sistema operativo
creatividades HTML
calendario de ofertas
Todos estos tipos de datos tienen parámetros obligatorios
un parámetro principal para cada tipo
parámetro(s) obligatorio(s) dentro de cada matriz (marcados con * en el documento de la API)
🔎 La lista de parámetros principales para cada tipo de datos:
payments: para pagos
landings : para páginas de aterrizaje y preaterrizaje
caps: para caps
commission_tiers: para niveles de comisión
targeting : para los grupos de targeting
schedule: para el calendario de ofertas
creativesHtml: para creatividades HTML
🔎 Los parámetros obligatorios para crear una oferta son:
título
anunciante
url
pagos
Si no sabes, qué valores añadir (por ejemplo, los códigos ISO de los países), utiliza los métodos de aquí y aquí, que te ayudarán a obtener la lista de valores disponibles.
El método: POST /3.0/admin/oferta
La petición cURL para añadir una oferta con las siguientes propiedades:
el estado Activo.
el nivel de privacidad Privado.
la casilla CPI seleccionada.
la nota.
un grupo de destino general para Francia, Alemania e Italia, para Android >= 6.0.0.
un pago general para los mismos países, el tipo de pago fijo en USD.
una regla de tope para 1000 conversiones para el plazo = mes, objetivo = todos, afiliados = todos.
dos 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=Nueva Oferta' \ --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=Es la oferta más reciente' \ --data 'targeting[0][country][allow][0]=FR' \ --data 'targeting[0][country][allow][1]=DE' \ --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][countries][2]=IT' \ --data 'payments[0][currency]=USD' \ --data 'payments[0][type]=fixed' \ --data 'caps[0][period]=month' \ --data 'payments[0][countries][2]=IT' \ --data 'payments[0][currency]=USD' \ --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]=Citas online' \ --data 'landings[0][url]=http://nuevo-enlace-de-seguimiento.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'⚠️ Asegúrese de que cumple todos los requisitos para el tipo de matriz de datos, incluidos los corchetes y la numeración.
Añadir una oferta con logotipo o creatividades
Utilice este método para añadir una oferta con logotipo o creatividades. Además de los parámetros obligatorios que se mencionaron antes, puede añadir los siguientes:
creativeFiles
creativeUrls
creativeDownloads
creativesHtml
creativeAssets
creativeFileTitles
creativeUrlTitles
creativeDownloadTitles
logotipo
⚠️ Si crea una oferta manualmente a través de la API y desea añadir un logotipo o archivos creativos/descargas, asegúrese de utilizar el siguiente encabezado content-type: multipart/form-data.
La solicitud podría tener este aspecto:
Puede ver una demostración de cómo añadir un archivo con un logotipo:
La petición cURL para la creación de la oferta con logotipo y creatividades:
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=OFERTA CON LOGOTIPO Y CREATIVAS' \--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 una oferta
Utilice este método para editar una oferta: todos los ajustes o sólo una parte de la oferta. Recomendamos leer el artículo sobre la edición del tipo de datos array antes de utilizar este método.
El método: POST /3.0/admin/oferta/{ID}
La solicitud cURL para editar un grupo de segmentación en la misma oferta, que se utiliza como ejemplo para añadir la oferta. En el ejemplo, se ha modificado lo siguiente:
Francia, Alemania e Italia se sustituyeron por Islandia e Irlanda.
la versión del sistema operativo se cambió a 7.0.0.
se habilitó la herramienta proxy antifraude.
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][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 =
⚠️ Asegúrese de que cumple todos los requisitos para el tipo de matriz de datos, incluidos los paréntesis y la numeración.
Habilitar afiliados
Utilice este método para permitir que su afiliado trabaje con la oferta. El método sólo es relevante si el nivel de privacidad de la oferta es Premoderación o Privado.
El método: POST /3.0/oferta/habilitar-afiliado.
La petición cURL para habilitar el afiliado #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
Desactivar afiliados
Utilice este método para permitir que su afiliado trabaje con la oferta. El método es relevante para ofertas con todos los niveles de privacidad.
El método: POST /3.0/oferta/desactivar-afiliado.
La petición cURL para desactivar el 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
La lista de afiliados desactivados/activados
Utilice este método para obtener la lista de afiliados, que pueden o no pueden trabajar con la oferta en particular.
El método: GET /3.1/ofertas/{ID}/privacidad.
La solicitud:
https://api-rocketcompany.affise.com/3.1/offers/1441594/privacy?api-key=4sdf87fsdfd8723lkjhrn324
Actualizar el estado de las ofertas
Utilice este método para modificar masivamente el estado de las ofertas.
El método: POST /3.0/admin/offer/mass-update.
La petición cURL para cambiar el estado de tres ofertas a 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
Por favor, póngase en contacto con el equipo de Atención al Cliente de Affise en relación con todas las cuestiones planteadas a través del correo electrónico: [email protected].