REST API V4: methodes
Overzicht van methodes
Account
In de onderstaande tabel vind je een methode om account-informatie op te vragen.
| Type | Adres | Omschrijving |
|---|---|---|
| GET | api.copernica.com/v4/identity | Opvragen van account informatie |
| GET | api.copernica.com/v4/consumption | Opvragen van account verbruik |
Databases & Collecties
Je kunt je databases en collecties bekijken en onderhouden met API calls. In de onderstaande tabel vind je alle calls gerelateerd aan databases, collecties en hun eigenschappen.
Databases
Collecties
Importeren
| Type | Adres | Omschrijving |
|---|---|---|
| POST | api.copernica.com/v4/imports | Importeren van gegevens in je account |
| GET | api.copernica.com/v4/import/$id | Opvragen van informatie over een import |
Selecties & Miniselecties
Selecties vallen onder de database, terwijl miniselecties onder een collectie vallen. Je kunt de methodes gerelateerd aan specifieke (mini)selecties hieronder vinden.
Selecties
| Type | Adres | Omschrijving |
|---|---|---|
| POST | api.copernica.com/v4/database/$id/views | Aanmaken van een selectie |
| POST | api.copernica.com/v4/view/$id/copy | Kopiëren van een selectie |
| GET | api.copernica.com/v4/view/$id | Opvragen van selectie informatie |
| PUT | api.copernica.com/v4/view/$id | Updaten van selectie informatie |
| DELETE | api.copernica.com/v4/view/$id | Verwijderen van een selectie |
| GET | api.copernica.com/v4/view/$id/views | Opvragen van alle genestelde selecties |
| POST | api.copernica.com/v4/view/$id/views | Aanmaken van een genestelde selectie |
| GET | api.copernica.com/v4/view/$id/profileids | Opvragen van alle selectie profiel IDs |
| GET | api.copernica.com/v4/view/$id/profiles | Opvragen van alle selectie profielen |
| GET | api.copernica.com/v4/view/$id/rules | Opvragen van alle selectie regels |
| GET | api.copernica.com/v4/view/$id/rule/$id | Opvragen van een selectie regel |
| POST | api.copernica.com/v4/view/$id/rules | Aanmaken van een selectie regel |
| PUT | api.copernica.com/v4/view/$id/intentions | Updaten van de intenties van de selectie |
| POST | api.copernica.com/v4/view/$id/rebuild | Opnieuw opbouwen van een selectie |
Miniselecties
| Type | Adres | Omschrijving |
|---|---|---|
| POST | api.copernica.com/v4/collection/$id/miniviews | Aanmaken van een miniselectie |
| GET | api.copernica.com/v4/miniview/$id | Opvragen van miniselectie informatie |
| PUT | api.copernica.com/v4/miniview/$id | Updaten van miniselectie informatie |
| DELETE | api.copernica.com/v4/miniview/$id | Verwijderen van een miniselectie |
| GET | api.copernica.com/v4/miniview/$id/subprofileids | Opvragen van alle miniselectie subprofiel IDs |
| GET | api.copernica.com/v4/miniview/$id/subprofiles | Opvragen van alle miniselectie subprofielen |
| GET | api.copernica.com/v4/miniview/$id/views | Opvragen van selecties voor een miniselectie |
| GET | api.copernica.com/v4/miniview/$id/minirules | Opvragen van alle miniselectie miniregels |
| GET | api.copernica.com/v4/miniview/$id/minirule/$id | Opvragen van een miniselectie miniregel |
| POST | api.copernica.com/v4/miniview/$id/minirules | Aanmaken van een nieuwe miniselectie miniregel |
| PUT | api.copernica.com/v4/miniview/$id/intentions | Updaten van de intenties van de miniselectie |
| POST | api.copernica.com/v4/miniview/$id/rebuild | Opnieuw opbouwen van een miniselectie |
Regels & Miniregels
Regels en miniregels bestaan uit een of meerdere condities om selecties en miniselecties aan te maken onder een database of collectie respectievelijk. Je kunt alle API calls gerelateerd aan (mini)regels en de bijhorende condities in de tabel hieronder vinden.
Regels
| Type | Adres | Omschrijving |
|---|---|---|
| POST | api.copernica.com/v4/view/$id/rules | Aanmaken van een regel |
| GET | api.copernica.com/v4/rule/$id | Opvragen van regel informatie |
| PUT | api.copernica.com/v4/rule/$id | Updaten van regel informatie |
| DELETE | api.copernica.com/v4/rule/$id | Verwijderen van een regel |
| POST | api.copernica.com/v4/rule/$id/conditions | Aanmaken van een regel conditie |
| PUT | api.copernica.com/v4/condition/$type/$id | Updaten van een conditie |
| DELETE | api.copernica.com/v4/condition/$type/$id | Verwijderen van een conditie |
Miniregels (voor miniselecties)
| Type | Adres | Omschrijving |
|---|---|---|
| POST | api.copernica.com/v4/miniview/$id/minirules | Aanmaken van een nieuwe miniregel |
| GET | api.copernica.com/v4/minirule/$id | Opvragen van miniregel informatie |
| PUT | api.copernica.com/v4/minirule/$id | Updaten van miniregel informatie |
| DELETE | api.copernica.com/v4/minirule/$id | Verwijderen van een miniregel |
| POST | api.copernica.com/v4/minirule/$id/conditions | Aanmaken van een miniregel conditie |
| PUT | api.copernica.com/v4/minicondition/$type/$id | Updaten van een miniregel conditie |
| DELETE | api.copernica.com/v4/minicondition/$type/$id | Verwijderen van een miniregel conditie |
Profielen & Subprofielen
Profielen en subprofielen kunnen gebruikt worden om entiteiten in je database op te slaan, zoals je klanten of orders. Je vindt de relevante API calls in de onderstaande tabel.
Profielen
| Type | Adres | Omschrijving |
|---|---|---|
| POST | api.copernica.com/v4/database/$id/profiles | Aanmaken van een database profiel |
| GET | api.copernica.com/v4/profile/$id | Opvragen van profiel informatie |
| PUT | api.copernica.com/v4/profile/$id | Updaten van profiel informatie |
| DELETE | api.copernica.com/v4/profile/$id | Verwijderen van een profiel |
| GET | api.copernica.com/v4/profile/$id/subprofiles/$id | Opvragen van alle subprofielen voor een profiel |
| POST | api.copernica.com/v4/profile/$id/subprofiles/$id | Aanmaken van een nieuw subprofiel |
| PUT | api.copernica.com/v4/profile/$id/subprofiles/$id | Updaten van een of meerdere subprofielen |
| GET | api.copernica.com/v4/profile/$id/fields | Opvragen van alle profiel velden |
| PUT | api.copernica.com/v4/profile/$id/fields | Updaten van een of meerdere profiel velden |
| GET | api.copernica.com/v4/profile/$id/interests | Opvragen van alle profiel interesses |
| POST | api.copernica.com/v4/profile/$id/interests | Aanmaken van profiel interesse(s) |
| PUT | api.copernica.com/v4/profile/$id/interests | Updaten van profiel interesse(s) |
| GET | api.copernica.com/v4/profile/$id/html/emailings | Opvragen van alle HTML mailings voor een profiel |
| GET | api.copernica.com/v4/profile/$id/draganddrop/emailings | Opvragen van alle Marketing Suite mailings voor een profiel |
| GET | api.copernica.com/v4/profile/$id/html/destinations | Opvragen van alle HTML mailing destinations voor een profiel |
| GET | api.copernica.com/v4/profile/$id/draganddrop/destinations | Opvragen van alle Marketing Suite destinations voor een profiel |
| GET | api.copernica.com/v4/profile/$id/files | Opvragen van alle files voor een profiel |
| GET | api.copernica.com/v4/profile/$id/file/$id/json | Opvragen van informatie van een file |
| GET | api.copernica.com/v4/profile/$id/file/$id/json | Opvragen van content van een file |
| POST | api.copernica.com/v4/profile/$id/datarequest | Aanmaken van een dataverzoek voor een profiel |
| PUT | api.copernica.com/v4/profile/$id/unsubscribe | Uitvoeren van het uitschrijfgedrag van een profiel |
| GET | api.copernica.com/v4/profile/$id/html/document/$id | Opvragen van een gepersonaliseerd HTML document voor een profiel |
Subprofielen
| Type | Adres | Omschrijving |
|---|---|---|
| POST | api.copernica.com/v4/profile/$id/subprofiles | Aanmaken van een subprofiel |
| GET | api.copernica.com/v4/subprofile/$id | Opvragen van subprofiel informatie |
| PUT | api.copernica.com/v4/subprofile/$id | Updaten van subprofiel informatie |
| DELETE | api.copernica.com/v4/subprofile/$id | Verwijderen van een subprofiel |
| GET | api.copernica.com/v4/subprofile/$id/fields | Opvragen van alle subprofiel velden |
| PUT | api.copernica.com/v4/subprofile/$id/fields | Updaten van subprofiel velden |
| GET | api.copernica.com/v4/subprofile/$id/html/emailings | Opvragen van alle HTML mailings voor een subprofiel |
| GET | api.copernica.com/v4/subprofile/$id/draganddrop/emailings | Opvragen van alle Marketing Suite mailings voor een subprofiel |
| GET | api.copernica.com/v4/subprofile/$id/html/destinations | Opvragen van alle HTML mailing destinations voor een subprofiel |
| GET | api.copernica.com/v4/subprofile/$id/draganddrop/destinations | Opvragen van alle Marketing Suite destinations voor een subprofiel |
| POST | api.copernica.com/v4/subprofile/$id/datarequest | Aanmaken van een dataverzoek voor een subprofiel |
| PUT | api.copernica.com/v4/subprofile/$id/unsubscribe | Uitvoeren van het uitschrijfgedrag van een subprofiel |
| GET | api.copernica.com/v4/subprofile/$id/html/document/$id | Opvragen van een gepersonaliseerd HTML document voor een subprofiel |
HTML mailings
In de onderstaande tabel vind je alle API calls gerelateerd aan Publisher documenten, templates en mailings.
Mailings
| Type | Adres | Omschrijving |
|---|---|---|
| GET | api.copernica.com/v4/html/emailings | Opvragen van alle mailings |
| GET | api.copernica.com/v4/html/scheduledemailings | Opvragen van alle ingeroosterde mailings |
| GET | api.copernica.com/v4/html/emailing/$id | Opvragen van een mailing |
| GET | api.copernica.com/v4/html/scheduledemailing/$id | Opvragen van een ingeroosterde mailing |
| GET | api.copernica.com/v4/html/destinations | Opvragen van alle destinations over een bepaalde periode |
| POST | api.copernica.com/v4/html/emailing | Aanmaken van een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/destinations | Opvragen van destinations voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/snapshot | Opvragen van een snapshot voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/statistics | Opvragen van de statistieken voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/abuses | Opvragen van abuses voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/clicks | Opvragen van clicks voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/deliveries | Opvragen van deliveries voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/errors | Opvragen van errors voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/impressions | Opvragen van impressies voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/unsubscribes | Opvragen van unsubscribes voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/testgroups | Opvragen van de testgroepen voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/finalgroup | Opvragen van de definitieve groep voor een mailing |
| PUT | api.copernica.com/v4/html/emailing/$id/unsubscribe | (Sub)profiel uitschrijven op basis van een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/hyperlinkextensions | Opvragen van alle hyperlink extensions voor een mailing |
| GET | api.copernica.com/v4/html/testgroup/$id/statistics | Opvragen van de statistieken van een testgroep |
| GET | api.copernica.com/v4/html/message/$id | Opvragen van bericht informatie |
| GET | api.copernica.com/v4/profile/$id/html/emailings | Opvragen van alle HTML mailings voor een profiel |
| GET | api.copernica.com/v4/subprofile/$id/html/emailings | Opvragen van alle HTML mailings voor een subprofiel |
| GET | api.copernica.com/v4/message/$id/body | Opvragen van de body van een Marketing Suite mailing |
Documenten & Templates
Destinations (bestemmingen)
| Type | Adres | Omschrijving |
|---|---|---|
| GET | api.copernica.com/v4/html/destination/$id/ | Opvragen van een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/body | Opvragen van de message body verzonden naar een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/fields | Opvragen van een bestemming inclusief profielvelden |
| GET | api.copernica.com/v4/html/destination/$id/statistics | Opvragen van statistieken voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/abuses | Opvragen van abuses voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/clicks | Opvragen van clicks voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/deliveries | Opvragen van deliveries voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/errors | Opvragen van errors voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/impressions | Opvragen van impressies voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/unsubscribes | Opvragen van unsubscribes voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/content | Opvragen van de verstuurde inhoud voor een bestemming |
| GET | api.copernica.com/v4/profile/$id/html/destinations | Opvragen van HTML mailing destinations voor een profiel |
| GET | api.copernica.com/v4/subprofile/$id/html/destinations | Opvragen van HTML mailing destinations voor een subprofiel |
Statistieken
| Type | Adres | Omschrijving |
|---|---|---|
| GET | api.copernica.com/v4/html/abuses | Opvragen van alle abuses voor HTML-mailings |
| GET | api.copernica.com/v4/html/clicks | Opvragen van alle clicks voor HTML-mailings |
| GET | api.copernica.com/v4/html/deliveries | Opvragen van alle deliveries voor HTML-mailings |
| GET | api.copernica.com/v4/html/errors | Opvragen van alle errors voor HTML-mailings |
| GET | api.copernica.com/v4/html/impressions | Opvragen van alle impressions voor HTML-mailings |
| GET | api.copernica.com/v4/html/unsubscribes | Opvragen van alle unsubscribes voor HTML-mailings |
| GET | api.copernica.com/v4/html/emailing/$id/statistics | Opvragen van de statistieken voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/abuses | Opvragen van abuses voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/clicks | Opvragen van clicks voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/deliveries | Opvragen van deliveries voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/errors | Opvragen van errors voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/impressions | Opvragen van impressies voor een mailing |
| GET | api.copernica.com/v4/html/emailing/$id/unsubscribes | Opvragen van unsubscribes voor een mailing |
| GET | api.copernica.com/v4/html/destination/$id/statistics | Opvragen van statistieken voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/abuses | Opvragen van abuses voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/clicks | Opvragen van clicks voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/deliveries | Opvragen van deliveries voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/errors | Opvragen van errors voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/impressions | Opvragen van impressies voor een bestemming |
| GET | api.copernica.com/v4/html/destination/$id/unsubscribes | Opvragen van unsubscribes voor een bestemming |
Marketing Suite Mailings
In de onderstaande tabel vind je alle API calls gerelateerd aan Marketing Suite templates en mailings.
Mailings
Templates
| Type | Adres | Omschrijving |
|---|---|---|
| GET | api.copernica.com/v4/draganddrop/templates | Opvragen van alle templates |
| GET | api.copernica.com/v4/draganddrop/template/$id | Opvragen van een template |
| DELETE | api.copernica.com/v4/draganddrop/template/$id | Verwijderen van een template |
| GET | api.copernica.com/v4/draganddrop/template/$id/statistics | Opvragen van statistieken voor een template |
| POST | api.copernica.com/v4/draganddrop/template/$id/translations | Aanmaken van een taal voor een template |
| GET | api.copernica.com/v4/draganddrop/template/$id/translations | Opvragen van vertalingen van een template |
| PUT | api.copernica.com/v4/draganddrop/template/$id/translations | Aanpassen van vertalingen van een template |
| GET | api.copernica.com/v4/draganddrop/directories | Opvragen van alle Marketing Suite template folders |
| GET | api.copernica.com/v4/draganddrop/directory/$id | Opvragen van informatie van de template folder |
Destinations (bestemmingen)
Binnen Copernica's Marketing Suite zijn de termen 'destination' (bestemming) en 'message' (bericht) uitwisselbaar. Beide verwijzen naar een specifiek bericht verzonden naar een specifieke bestemming. In onderstaande artikelen kun je in zowel de tekst 'destination' door 'message' vervangen, of andersom. Dit geldt ook voor de voorbeeldcode.
Statistieken
SMS Mailings
| Type | Adres | Omschrijving |
|---|---|---|
| GET | api.copernica.com/v4/smsmailing/$id | Opvragen van een SMS mailing |
Coupons
| Type | Adres | Omschrijving |
|---|---|---|
| GET | https://api.copernica.com/v4/couponcampaigns | Opvragen van alle couponcampagnes |
| POST | https://api.copernica.com/v4/couponcampaigns | Aanmaken van een couponcampagne |
| PUT | https://api.copernica.com/v4/couponcampaign/$id | Bijwerken van een couponcampagne |
| GET | https://api.copernica.com/v4/couponcampaign/$id | Opvragen van couponcampagne informatie |
| PUT | https://api.copernica.com/v4/couponcampaign/$id/coupons | Aanmaken of bijwerken van een of meerdere coupons binnen een couponcampagne |
| GET | https://api.copernica.com/v4/couponcampaign/$id/coupons | Opvragen van een of meerdere coupons binnen een couponcampagne |
Mediabibliotheken
| Type | Adres | Omschrijving |
|---|---|---|
| POST | api.copernica.com/v4/medialibrary/$id/files | Toevoegen van een bestand/afbeelding aan je mediabibliotheek |
Dataverzoeken
Nadat alle data voor een dataverzoek is verzameld wordt de data voor een korte periode op de Copernica servers opgeslagen. Met de onderstaande calls kun je dataverzoeken aanmaken en de data en status van deze verzoeken opvragen.
| Type | Adres | Omschrijving |
|---|---|---|
| POST | api.copernica.com/v4/profile/$id/datarequest | Aanmaken dataverzoek voor een profiel |
| POST | api.copernica.com/v4/subprofile/$id/datarequest | Aanmaken dataverzoek voor een subprofiel |
| GET | api.copernica.com/v4/datarequest/$id/data | Opvragen data van een dataverzoek |
| GET | api.copernica.com/v4/datarequest/$id/status | Opvragen status van een dataverzoek |
Logfiles
Copernica houdt uitgebreide data bij over alles gerelateerd aan een mailing. Je kunt alle calls gerelateerd aan logfiles in de onderstaande tabel vinden.
| Type | Adres | Omschrijving |
|---|---|---|
| GET | api.copernica.com/v4/logfiles | Opvragen logfile datums |
| GET | api.copernica.com/v4/logfiles | Opvragen logfile namen |
| GET | api.copernica.com/v4/logfile/$filename/csv | Opvragen logfiles in CSV |
| GET | api.copernica.com/v4/logfile/$filename/json | Opvragen logfiles in JSON |
| GET | api.copernica.com/v4/logfile/$filename/xml | Opvragen logfiles in XML |
Webhooks
Webhooks zijn processen die hun gebruiker op de hoogte stellen van gebeurtenissen die realtime plaatsvinden via HTTP POST. Je kunt alle calls gerelateerd aan webhooks in de onderstaande tabel vinden.
| Type | Adres | Omschrijving |
|---|---|---|
| GET | api.copernica.com/v4/webhook/$id | Opvragen van een webhook |
| POST | api.copernica.com/v4/webhooks | Aanmaken van een webhook |
| PUT | api.copernica.com/v4/webhook/$id | Updaten van een webhook |
| DELETE | api.copernica.com/v4/webhook/$id | Verwijderen van een webhook |
Sender domains
Een senderdomain wordt gebruikt om e-mails te versturen via Copernica. Wanneer je een domein instelt als senderdomain zorgen wij er voor dat je DNS records automatisch bijgewerkt worden. Je Click, Bounce en Open domains en DKIM-sleutels zullen automatisch worden ingesteld.
| Type | Adres | Omschrijving |
|---|---|---|
| GET | api.copernica.com/v4/senderdomain/$id | Opvragen van een senderdomain |
| POST | api.copernica.com/v4/senderdomains | Aanmaken van een senderdomain |
| PUT | api.copernica.com/v4/senderdomain/$id | Updaten van een senderdomain |
| DELETE | api.copernica.com/v4/senderdomain/$id | Verwijderen van een senderdomain |
Events
Copernica is een event driven platform. Bepaalde gebeurtenissen die plaatsvinden in of buiten Copernica worden opgevangen en verwerkt en gebruikt om opvolgacties uit te voeren. Met behulp van de REST API kunnen een aantal van deze evenementen worden getriggered.