REST API v4: GET document imageblocks (HTML mailings)
Dit is een methode om de afbeeldingsblokken van een document op te vragen. De methode is aan te roepen met een HTTP GET-request naar de volgende URL:
https://api.copernica.com/v4/html/document/$id/imageblocks
Als $id
kun je de numerieke identifier van een document opgeven.
Geretourneerde velden
Variabele | Omschrijving |
---|---|
ID | Unieke identifier van het afbeeldingsblok. |
parentID | Unieke identifier van het bovenliggende afbeeldingsblok. |
name | Naam van het afbeeldingsblok. |
iteration | Iteratie waar het afbeeldingsblok in zit. |
condition | Eventuele condities van het afbeeldingsblok. |
JSON voorbeeld
De JSON voor het ophalen van afbeeldingsblokken ziet er bijvoorbeeld zo uit:
{
"ID": "1",
"parentID": "",
"name": "imageblock",
"iteration": "0",
"condition": "",
}
Voorbeeld in PHP
Het volgende PHP-script demonstreert hoe je de API-methode kunt aanroepen:
// vereiste scripts
require_once("CopernicaRestAPI.php");
// verander dit in je access token
$api = new CopernicaRestAPI("your-access-token", 4);
// voer de opdracht uit en print het resultaat
print_r($api->get("html/document/{$documentID}/imageblocks"));
Dit voorbeeld vereist de REST API-klasse.