REST API v4: GET destination (HTML mailings)

Je kunt de REST API gebruiken om een overzicht van een mailing destination (bestemming) op te vragen door een HTTP GET verzoek te versturen naar de volgende URL:

https://api.copernica.com/v4/html/destination/$id

Hier moet $id vervangen worden door de ID van de destination. Deze methode ondersteunt ook het gebruik van de fields parameter voor het timestampsent veld.

Teruggegeven velden

Deze methode geeft een JSON object terug dat de destination representeert. Deze bevat de volgende velden:

  • ID: De ID van de destination.
  • timestampsent: De tijdstempel van het aankomen van de mailing bij deze destination.
  • internal: De interne ID van deze destination.
  • profile: De ID van het profiel van deze destination.
  • subprofile: De ID van het subprofiel van deze destination (als deze beschikbaar is).
  • mailing: De ID van de mailing.

(Sub)profielvelden opvragen

Het is daarnaast mogelijk om ook de velden van het corresponderende (sub)profiel op te vragen. In dit geval zullen de 'profile' en 'subprofile' velden een array bevatten met velden 'ID' voor de identifier en 'fields' voor de (subprofiel) velden. Je kunt de methode aanroepen met een HTTP GET call naar de volgende URL:

https://api.copernica.com/v4/html/destination/$id/fields

JSON voorbeeld

De JSON voor de destination ziet er bijvoorbeeld zo uit:

{  
   "ID":"56ed14bf71f7bc4e200e712e646ed32f",
   "timestampsent":"2014-08-26 10:14:15",
   "internal":"802345",
   "profile":"9180926",
   "subprofile":null,
   "mailing":"42913"
}

PHP voorbeeld

Het onderstaande script demonstreert hoe je deze API methode gebruikt. Vergeet niet de ID in de URL te vervangen voor je het verzoek uitvoert.

// vereiste scripts
require_once('CopernicaRestAPI.php');

// verander dit naar je access token
$api = new CopernicaRestAPI("your-access-token", 4);

// voer het verzoek uit
print_r($api->get("html/destination/{$destinationID}"));

Dit voorbeeld vereist de REST API klasse

Meer informatie