Skip to main content

AWIN Advertiser Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to an AWIN Advertiser location.
awin_advertiser_api.png

AWIN Advertiser

Create an AWIN Advertiser Destination​

  1. Click the + icon on the Nexset that will be sent to the AWIN Advertiser destination, and select the Send to Destination option from the menu.

  2. Select the AWIN Advertiser connector from the list of available destination connectors. Then, select the credential that will be used to connect to the AWIN Advertiser organization, and click Next; or, create a new AWIN Advertiser credential for use in this flow.

  3. In Nexla, AWIN Advertiser destinations can be created using pre-built endpoint templates, which expedite destination setup for common AWIN Advertiser endpoints. Each template is designed specifically for the corresponding AWIN Advertiser endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    AWIN Advertiser destinations can also be configured manually, allowing you to send data to AWIN Advertiser endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common AWIN Advertiser endpoints. Each template is designed specifically for the corresponding AWIN Advertiser endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Submit Proof-of-Purchase Publisher Transaction

    This endpoint submits proof-of-purchase transactions from a CLO (Card-Linked Offer) publisher directly to an advertiser's program. Use this template to push completed order data into Awin in batches of up to 1,000 orders per call.

    • Enter your Awin advertiser account ID in the Advertiser Id field. This ID is used as a path parameter against the server-to-server endpoint {'POST https://api.awin.com/s2s/advertiser/{advertiserId}/orders'}.
    • Each record sent from Nexla must conform to Awin's proof-of-purchase order schema. Review the Awin S2S documentation for the exact field structure expected for each order.
    • This endpoint uses the x-api-key header for authentication, which Nexla populates automatically from the API token stored in the configured credential.

    Awin accepts up to 1,000 orders per request on this endpoint. Configure the Record Batching settings in the Advanced tab if you need to chunk a larger payload into compliant batches.

    Validate Advertiser Transactions

    This endpoint approves, declines, or amends a batch of transactions for the given advertiser by sending a PATCH request to {'/advertisers/{advertiserId}/transactions'}. Use this template to programmatically validate Awin transactions based on internal order, fraud, or returns data.

    • Enter your Awin advertiser account ID in the Advertiser Id field.
    • Each Nexset record sent to this endpoint should contain the transaction ID along with the new status (approve, decline, or amend) and any supporting fields, formatted according to Awin's transaction validation schema.
    • Awin executes validation asynchronously: a successful response returns a job identifier that can be inspected with the Get Advertiser Transaction Job by ID source endpoint.

    Combine this destination with the Get Advertiser Transaction Jobs source endpoint to monitor validation outcomes and surface any rejected records for re-processing.

Configure Manually​

AWIN Advertiser destinations can be manually configured to send data to any valid AWIN Advertiser API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the AWIN Advertiser API after each call to a new Nexla webhook data source. This is particularly useful for capturing Awin job IDs returned from validation calls.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the AWIN Advertiser API from the Method pulldown menu. Common methods for Awin write operations are:

    • POST: For submitting new proof-of-purchase orders to the S2S endpoint
    • PATCH: For approving, declining, or amending existing transactions

Data Format​

  1. Select the format in which the Nexset data will be sent to the AWIN Advertiser API from the Content Format pulldown menu. All Awin write endpoints expect application/json payloads, so select JSON unless you have an explicit reason to use a different format.

API Endpoint URL​

  1. Enter the URL of the AWIN Advertiser API endpoint to which you want to send the Nexset data in the URL field. Awin write endpoints are hosted at https://api.awin.com. Example URLs:
    • Submit orders: {'https://api.awin.com/s2s/advertiser/{advertiserId}/orders'}
    • Validate transactions: {'https://api.awin.com/advertisers/{advertiserId}/transactions'}

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). For Awin, custom headers are rarely required—Nexla automatically applies the Authorization: Bearer ... header for the validate endpoint and the x-api-key header for the S2S proof-of-purchase endpoint based on the configured credential.

    You do not need to include any headers already present in the credentials.

Rate Limiting​

Awin enforces a throttling limit of 20 API calls per minute per user account. When sending large volumes of validation or proof-of-purchase data, configure Record Batching to consolidate multiple records into a single API call rather than firing one call per record.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this AWIN Advertiser destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching. Batching is strongly recommended for the Awin proof-of-purchase endpoint, which accepts up to 1,000 orders per request.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100. Set this to a value at or below 1,000 for the Awin S2S endpoint.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

    Property Inside JSON Object

    1. Enter the name of the JSON property that should contain the batched records in the Property Name field. For example, Awin's validate-transactions endpoint expects the batched array to be wrapped in a top-level property.
    2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

    Code

    1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the AWIN Advertiser API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call. For Awin, this is particularly valuable for capturing the asynchronous job IDs returned by the validate-transactions endpoint so that downstream flows can poll job status.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the AWIN Advertiser API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the AWIN Advertiser API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the AWIN Advertiser API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured AWIN Advertiser endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to AWIN Advertiser until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.