REST API v4: GET Publisher personalized document (subprofiel)

Je kan een gepersonaliseerd Publisher-document van een subprofiel opvragen met een HTTP GET-call naar de volgende URL:

https://api.copernica.com/v4/subprofile/$subprofileID/html/document/$documentID

Hier moet $subprofileID vervangen worden door het ID van het subprofiel en $documentID door het ID van het document.

Teruggegeven velden

Deze methode geeft een JSON-object terug met de volgende informatie:

  • id: ID van het document
  • template: ID van de template
  • name: naam van het document
  • description: omschrijving van het document
  • from_address: afzenderadres van het document
  • subject: onderwerp van het document
  • archived: geeft aan of dit document gearchiveerd is (true) of niet (false)
  • source: gepersonaliseerde broncode van het document op basis van het opgegeven subprofiel-ID

JSON voorbeeld

De JSON ziet er bijvoorbeeld zo uit:

{
    "id": "285",
    "template": "114",
    "name": "Test",
    "description": "",
    "from_address": "\"Jeroen\" <info@copernica.com>",
    "subject": "Test",
    "archived": false,
    "source": "<html>\n\t<body>\nDit is een test<br />\n</body>\n</html>"
}

PHP voorbeeld

Dit script demonstreert hoe je de API-methode kunt gebruiken:

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

Dit voorbeeld vereist de REST API-klasse.

Meer informatie