Documentatie

Een fout gevonden?

Je kan deze pagina op GitHub vinden.

Een wijziging voorstellen

Templates beheren

In de dashboard omgeving van SMTPeter kun je gemakkelijk templates beheren. Deze templates zijn ook beschikbaar door gebruik van de REST API. Er zijn methodes om templates te downloaden, te editten of te creëren. Daarnaast is het natuurlijk ook mogelijk om een e-mail te versturen door middel van templates.

Haal templates op

Binnen je eigen SMTPeter omgeving kun je de algehele lijst van templates opvragen. Dit kun je doen door een HTTP GET call te versturen naar de volgende URL (vergeet niet om je API sleutel toe te voegen):

https://www.smtpeter.com/v1/templates/{start}/{length}

De templates methode is alleen beschikbaar als je een HTTP GET methode wilt doen. Je kunt de grenzen afbakenen door middel van {start} en {length}, zodat je niet de ineens een groot aantal templates terugkrijgt. De default waarde is 0 en 100. De call geeft een JSON array terug in het volgende formaat:

[
    {
        "id": "1",
        "name": "Nieuwsbrief",
        "directory": {
            "id": "2",
            "name": "Campagnes",
            "parent": {
                "id": "1",
                "name": "Marketing",
                "parent": null
            }
        }
    },
    {
        "id": "2",
        "name": "Bevestigingsmail",
        "directory": null
    }
]

Naast de unieke identifier en naam van een template wordt ook de map waarin het template staat teruggegeven via de directory property.

Als de map onderdeel is van een bovenliggende map, bevat directory een parent property met de gegevens van die bovenliggende map. Deze structuur wordt herhaald voor iedere bovenliggende map. Hierdoor kan de volledige mappenstructuur van een template worden bepaald.

Wanneer een map geen bovenliggende map heeft, is parent null. Als een template niet in een map staat, is directory null.

Meer properties van een template kunnen worden opgevraagd door de API aan te roepen met het unieke ID van de template.

Een specifieke template opvragen

Je kunt de REST API gebruiken om een specifieke template op te vragen door middel van een HTTP GET call. Je moet hiervoor wel de specifieke ID van een template weten.

https://www.smtpeter.com/v1/template/{ID}/{format}

Je kunt ook hier weer gebruik maken van een specifiek formaat. Dit kun je zelf opgeven in de call. Het default formaat is overigens JSON. De andere formaten zijn:

  • JSON: geeft de template terug in JSON formaat;
  • HTML: geeft de template terug in HTML formaat, geoptimaliseerd voor e-mailcliënten;
  • Webversion: geeft de template terug in HTML formaat, geoptimaliseerd voor webcliënten;
  • MIME: geeft de template terug in MIME formaat, met extern gehoste afbeeldingen;
  • Embedded: geeft de template terug in MIME formaat, met 'embedded' afbeeldingen;
  • Text: geeft de text versie terug van een template.

Je kunt ook extra personalisatie variabelen toevoegen in de GET method, zodat je template ook daadwerkelijk wordt gepersonaliseerd.

Als je altijd unieke namen aan jouw templates geeft, kun je in plaats van de template ID ook de naam van de template opgeven om een template op te vragen.

Creëren van templates

Naast het creëren van templates met behulp van de template editor, kun je ook nieuwe templates opslaan door deze met een HTTP POST methode te versturen naar SMTPeter:

https://www.smtpeter.com/v1/template/{format}

Je kunt de templates aanmaken door de JSON code toe te voegen aan de body van de POST request. De volledige specificaties van de ondersteunde properties kun je vinden op: www.ResponsiveEmail.com.

De API geeft een link terug van de nieuwe template in de location header. Ook wordt een klein JSON object terug gestuurd met daarin de template ID. De data die je in de body meegeeft aan de request moet altijd in JSON formaat zijn.

Voorbeeld van een request:

POST /v1/template/html?access_token=yourtoken
Host: www.smtpeter.com
Content-Type: application/json

{ "name" : "template..." }

HTTP/1.1 201 Created
Location: https://www.smtpeter.com/v1/template/2/html?access_token=yourtoken
Content-Type: application/json

{ "id" : 2 }

Updaten van templates

Je kunt ook een bestaande template updaten. Dit doe je door in plaats van een POST request een PUT request te versturen. Je voegt aan de JSON de id toe van de template die je wilt updaten. 

PUT /v1/template/html?access_token=yourtoken
Host: www.smtpeter.com
Content-Type: application/json

{ "id" : 2 }

HTTP/1.1 201 Created
Location: https://www.smtpeter.com/v1/template/2/html?access_token=yourtoken
Content-Type: application/json

{ "id" : 2 }

Als je altijd unieke namen aan jouw templates geeft, kun je een template ook updaten door de naam van de template mee te geven.

Meer informatie