API transaction validation NL

From Wiki

Jump to: navigation, search

Contents

Eindpunt Transactievalidatie-API

Opmerking: Eindpunt Transactievalidatie-API is alleen beschikbaar voor de Awin Accelerate- en Awin Advanced-platformaanbiedingen.

De Awin adverteerders-API ondersteunt transactievalidaties, waarmee u transacties met de Awin-API kunt goedkeuren, weigeren en wijzigen.

De Transactievalidatie-API beschikt over een batch-eindpunt, waarmee u meerdere validatieaanvragen in één inzending kunt groeperen.

Het eindpunt van de transactievalidatie-API maakt deel uit van de algehele API-infrastructuur van Awin. Als zodanig maakt het eindpunt gebruik van een op gebruikers gebaseerd OAUTH2-token. Voor meer informatie over OAUTH2 raadpleegt u de wikipagina API-verificatie en -autorisatie.


Awin streeft ernaar uw transactievalidatieverzoeken te verwerken binnen de financiële tijdslimieten van uw bedrijf. Daarom raden we u aan om verzoeken in te dienen voor 12:00 uur CET op de 15e dag van de maand en voor 12:00 uur CET op de laatste dag van de maand.

Batchtransactievalidatie

Batchtransactievalidatie maakt de overdracht en daaropvolgende verwerking van een lijst met een of meer JSON-geformatteerde transacties in één keer mogelijk. Om u in staat te stellen de voortgang van uw validatieverzoeken te volgen, biedt Awin een traceerbare jobID.



De API aanroepen

Method:
POST

URL:

https://api.awin.com/advertisers/<yourAdvertiserId>/transactions/batch


Verzoektekst:
De verzoektekst bevat een array met transactieobjecten. Elk object vertegenwoordigt de uit te voeren actie, de transactie en, indien nodig, eventuele aanvullende parameters. Transacties worden geïdentificeerd door transactionId of door orderRef, transactionDate en tijdzone.


"transactionId": "484816099",


"orderRef": "123ABC555",
"transactionDate": "2017-02-20T22:04:00",
"timezone": "Europe/Paris"



Beschikbare bewerkingen

Goedkeuren

Goedkeuren met transactionId:

{
"action": "approve",
"transaction":
    {
        "transactionId": 1234567
    }
}


Goedkeuren met orderRef, transactionDate en tijdzone:

{
"action": "approve",
"transaction":
    {
        "orderRef": "123ABC555",
        "transactionDate": "2017-02-20T22:04:00",
        "timezone": "Europe/Paris"
    }
}


Weigeren

Weigeren met transactionId:

{
"action": "decline",
"transaction":
    {
        "transactionId": 1234567,
        "declineReason": "order returned"
    }
}


Weigeren met orderRef, transactionDate en tijdzone:

{
"action": "decline",
"transaction":
    {
        "orderRef": "123ABC555",
        "transactionDate": "2017-02-20T22:04:00",
        "timezone": "Europe/Paris",
        "declineReason": "order returned"
    }
}



Wijzigen

Wijzigen met transactionId:

{
"action": "amend",
"approve": false,
"transaction":
    {
 
        "transactionId": 1234567,
        "amendReason": "partial return",
        "currency": "EUR",
        "saleAmount": 55.96,
        "transactionParts": [
          {
            "amount": 44.76,
            "commissionGroupCode": "DEFAULT"
          },
          {
            "amount": 11.20,
            "commissionGroupCode": "EXISTING"
          }
        ]
    }
}


Wijzigen met orderRef, transactionDate en tijdzone:

{
"action": "amend",
"approve": false,
"transaction":
    {
        "orderRef": "123ABC555",
        "transactionDate": "2017-02-20T22:04:00",
        "timezone": "Europe/Paris",
        "amendReason": "partial return",
        "currency": "EUR",
        "saleAmount": 55.96,
        "transactionParts": [
          {
            "amount": 44.76,
            "commissionGroupCode": "DEFAULT"
          },
          {
            "amount": 11.20,
            "commissionGroupCode": "EXISTING"
          }
        ]
    }
}


Opmerking:
Om de integriteit van wijzigingstransacties te waarborgen, moet de som van de transactiedelen identiek zijn aan het verkoopBedrag, anders wordt, om mogelijke verschillen te compenseren, de commissiegroep "DEFAULT" automatisch aangepast.



Als u de goedkeuringsparameter instelt op "true", wijzigt de API eerst de transactie en keurt de API deze transactie onmiddellijk daarna goed.



Verzoektekst

U moet de acties van de aanvraagtekst combineren met de definitieve hoofdtekst van de batchaanvraag. Hieronder ziet u een voorbeeld van een batch van drie transacties; één transactie 'goedkeuren', één transactie 'wijzigen' en één transactie 'weigeren':

[
  {
    "action": "amend",
    "approve": false,
    "transaction": {
        "transactionId": "484816099",
        "amendReason": "partial return",
        "currency": "EUR",
        "saleAmount": 44.76,
        "transactionParts": [{
            "amount": 44.76,
            "commissionGroupCode": "DEFAULT"
        }]
    }
  },
 
  {
    "action": "decline",
    "transaction":
      {
          "transactionId": 1234567,
          "declineReason": "order returned"
      }
  },
 
  {
  "action": "approve",
  "transaction":
      {
          "orderRef": "123ABC555",
          "transactionDate": "2017-02-20T22:04:00",
          "timezone": "Europe/Paris"
      }
  }
 
]


Als u de benodigde gegevens wilt verkrijgen, zoals de transactionId, gebruikt u de methode GET voor dit eindpunt. Raadpleeg voor meer informatie GET transacties (lijst).



Antwoordtekst

{
 "jobId": "5cbefc8646e0fb0001c4670e"
}

Met de jobId kunt u de status van alle taken die in behandeling zijn, tot 60 dagen nadat u de taak hebt gemaakt, bekijken.


Eindpunt taakstatus

Algemene taakstatus

Methode:
GET

URL:

https://api.awin.com/advertisers/<yourAdvertiserId>/transactions/jobs/<jobId>


Antwoordtekst

{
    "jobId": 5cbefc8646e0fb0001c4670e,
    "status": "DONE",
    "transactionCount": 100,
    "allTransactions": null,
    "errorCount": 0,
    "failedTransactions": null,
    "creationDate": "2017-02-20T22:04:00",
    "completionDate": "2017-02-20T22:24:00"
}

Als u geen query uitvoert op een gedetailleerde transactielijst of foutenlijst voor een taak, worden de objecten allTransactions en failedTransactions standaard ingesteld op "null". Raadpleeg voor meer informatie de sectie Gedetailleerde foutenlijst op deze pagina.


Gedetailleerde foutenlijst

Als u een extra lijst wilt geven van de transacties die tijdens de validatie een fout hebben gegenereerd, voegt u de parameter "output=errors" toe aan de URL. De API geeft een overzicht van de afzonderlijke transacties die zich binnen het object FailedTransactions bevinden. Als u een volledige lijst wilt genereren van alle transacties binnen het object allTransactions, voegt u in plaats daarvan de parameter "output=all" toe aan de URL.

'Methode:
GET

URL:

https://api.awin.com/advertisers/<yourAdvertiserId>/transactions/jobs/<jobId>?output=errors
 
https://api.awin.com/advertisers/<yourAdvertiserId>/transactions/jobs/<jobId>?output=all


Antwoordtekst

{
    "jobId":"5cb8290460b59a6e7ae22d0b",
    "status":"DONE",
    "transactions":2,
    "allTransactions":null, 
    "errors":2,
    "failedTransactions":
    [
      {
         "transactionId":1234567,
         "orderRef":null,
         "transactionDate":null,
         "timezone":"",
         "code":"[404 NOT_FOUND]",
         "description":null
      },
      {
         "transactionId":1234568,
         "orderRef":null,
         "transactionDate":null,
         "timezone":"",
         "code":"[404 NOT_FOUND]",
         "description":null
      }
    ],
    "creationDate":"2019-04-18T09:49:35.558",
    "completionDate":"2019-04-18T09:49:36.513"
}

Takenlijst

Als u een lijst met al uw taken van de afgelopen 60 dagen wilt genereren, roept u het taakeindpunt aan zonder een speciale taak-id op te geven.

Methode:'
GET

URL:

https://api.awin.com/advertisers/<yourAdvertiserId>/transactions/jobs


Algemene antwoordcodes

The following table contains a list of possible response reasons for common response codes that may appear when using the API:

Antwoordcode Antwoordbericht Mogelijke antwoordreden
200 OK De transactie werd zoals gewenst gevalideerd.
304 NOT_MODIFIED De transactie was al in de gewenste commissiestatus. Bijvoorbeeld proberen een geweigerde transactie te weigeren.
404 NOT_FOUND De transactionId of (orderRef, transactionDate, tijdzone) kwam niet overeen met een transactie.
422 UNPROCESSABLE_ENTITY Kan het verzoek niet voltooien vanwege de huidige transactiestatus. Bijvoorbeeld proberen een geweigerde transactie goed te keuren.

Privacy

Due to new European legislation regarding how websites store information about you, AWIN is updating its privacy policy. You can see the new version of our policy here. If you would like to see the information we capture on this website, please click here for further details. In order to accept cookies on this site please click the 'I ACCEPT' button