REST API v4: GET emailing document (HTML mailings)

Je kunt de REST API gebruiken om een overzicht van een emailing document op te vragen door een HTTP GET verzoek te versturen naar de volgende URL:

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

Hier moet $id vervangen worden door de ID van het emailing document.

Beschikbare parameters

Deze methode ondersteunt de source parameter. Deze boolean geeft aan of de HTML bron van het bestand opgevraagd moet worden ('true') of niet ('false'). Standaard zal deze op 'true' staan, maar de call kan sneller uitgevoerd worden door deze op 'false' te zetten.

Teruggegeven velden

Deze methode geeft een JSON object terug dat de volgende informatie bevat:

  • id: De ID van het emailing document.
  • template: De ID van de bijhorende template.
  • name: De naam van het document.
  • from_address: Het afzenderadres van het document.
  • subject: Het onderwerp van het document.
  • archived: Geeft aan of dit document gearchiveerd is (1) of niet (null).
  • source: De bron van het document.

JSON voorbeeld

De JSON voor een document ziet er bijvoorbeeld zo uit:

{  
   "id":"79",
   "template":"31",
   "name":"Hallo",
   "from_address":"\"test\" <test@copernica.nl>",
   "subject":"test",
   "archived":null,
   "source":"<html><head><title>Title</title></head><body><p>Paragraph</p></body></html>"
}

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/document/{$documentID}"));

Dit voorbeeld vereist de REST API klasse

Meer informatie