De REST API

Met de REST API kun je automatische koppelingen met Copernica maken. Je kunt bijvoorbeeld je website of app zo programmeren dat, met behulp van de REST API, gegevens in je Copernica-account worden ophaald, gecreëerd, geüpdatet of verwijderd. Dit gaat automatisch, dus buiten de user interface om.

REST API: overzicht van methodes

De volgende methodes zijn toegankelijk via HTTP GET, POST, PUT en DELETE.

GET

GET methodes worden gebruikt om data op te vragen. De volgende GET methodes zijn beschikbaar:

Methode Adres Omschrijving
GET api.copernica.com/v1/identity Opvragen identiteit van API koppeling
GET api.copernica.com/v1/databases Opvragen databases
GET api.copernica.com/v1/database/$id Opvragen databasegegevens
GET api.copernica.com/v1/database/$id/unsubscribe Opvragen afmeldalgoritme
GET api.copernica.com/v1/database/$id/fields Opvragen databasevelden
GET api.copernica.com/v1/database/$id/interests Opvragen interesses
GET api.copernica.com/v1/database/$id/collections Opvragen collecties
GET api.copernica.com/v1/database/$id/profiles Opvragen profielen
GET api.copernica.com/v1/database/$id/profileids Opvragen profiel identifiers
GET api.copernica.com/v1/database/$id/views Opvragen selecties
GET api.copernica.com/v1/view/$id Opvragen selectiegegevens
GET api.copernica.com/v1/view/$id/profiles Opvragen profielen in een selectie
GET api.copernica.com/v1/view/$id/profileids Opvragen profiel identifiers
GET api.copernica.com/v1/view/$id/rules Opvragen selectieregels
GET api.copernica.com/v1/view/$id/rule/$id Opvragen selectieregel
GET api.copernica.com/v1/view/$id/views Opvragen geneste selecties
GET api.copernica.com/v1/rule/$id Opvragen instellingen van selectieregel
GET api.copernica.com/v1/rule/$id/conditions Opvragen van selectieregels
GET api.copernica.com/v1/profile/$id Opvragen profielgegevens
GET api.copernica.com/v1/profile/$id/fields Opvragen profielvelden
GET api.copernica.com/v1/profile/$id/interests Opvragen interesses van profiel
GET api.copernica.com/v1/profile/$id/subprofiles Opvragen subprofielen van een profiel
GET api.copernica.com/v1/collection/$id Opvragen collectiegegevens
GET api.copernica.com/v1/collection/$id/fields Opvragen velden in een collectie
GET api.copernica.com/v1/collection/$id/miniviews Opvragen miniselecties onder een collectie
GET api.copernica.com/v1/collection/$id/subprofiles Opvragen subprofiles in een collectie
GET api.copernica.com/v1/collection/$id/subprofileids Opvragen subprofileids in een collectie
GET api.copernica.com/v1/collection/$id/unsubscribe Opvragen afmeldgedrag van een collectie
GET api.copernica.com/v1/miniview/$id Opvragen miniselectiegegevens
GET api.copernica.com/v1/miniview/$id/subprofiles Opvragen subprofielen in een miniselectie
GET api.copernica.com/v1/miniview/$id/subprofileids Opvragen subprofiel identifiers
GET api.copernica.com/v1/miniview/$id/rules Opvragen selectieregels
GET api.copernica.com/v1/miniview/$id/rule/$id Opvragen miniselectieregel
GET api.copernica.com/v1/minirule/$id Opvragen instellingen van miniselectieregel
GET api.copernica.com/v1/minirule/$id/conditions Opvragen van condities van een miniselectie
GET api.copernica.com/v1/subprofile/$id Opvragen subprofielgegevens
GET api.copernica.com/v1/subprofile/$id/fields Opvragen subprofielvelden
GET api.copernica.com/v1/logfiles Opvragen van alle logfiles
GET api.copernica.com/v1/logfiles/$date Opvragen van namen van logfiles
GET api.copernica.com/v1/logfiles/$name Downloaden van logfile in CSV formaat
GET api.copernica.com/v1/logfiles/$name/json Downloaden van logfile in JSON formaat
GET api.copernica.com/v1/logfiles/$name/xml Downloaden van logfile in XML formaat
GET api.copernica.com/v1/email/$addres/events Opvragen e-mail events
GET api.copernica.com/v1/message/$id/events Opvragen MS bericht events
GET api.copernica.com/v1/old/message/$id/events Opvragen Publisher bericht events
GET api.copernica.com/v1/old/document/$id/events Opvragen Publisher document events
GET api.copernica.com/v1/profile/$id/events Opvragen profiel events
GET api.copernica.com/v1/subprofile/$id/events Opvragen subprofiel events
GET api.copernica.com/v1/tags/$tag/events Opvragen tag events
GET api.copernica.com/v1/template/$id/events Opvragen MS template events
GET api.copernica.com/v1/old/template/$id/events Opvragen Publisher template events

Zie ook het algemene artikel over events.

PUT & POST

PUT en POST methodes worden gebruikt om data aan te maken en aan te passen. Dit zijn vaak zeer vergelijkbare methodes en als je geen POST methode kunt vinden voor wat je zoekt staat deze misschien onder PUT, of andersom. De volgende PUT en POST methodes zijn beschikbaar:

Methode Adres Omschrijving
POST api.copernica.com/v1/databases Aanmaken nieuwe database
PUT api.copernica.com/v1/database/$id Bijwerken databasegegevens
PUT api.copernica.com/v1/database/$id/unsubscribe Instellen afmeldalgoritme
POST api.copernica.com/v1/database/$id/fields Aanmaken databaseveld
PUT api.copernica.com/v1/database/$id/field/$id Veld uit database bijwerken
POST api.copernica.com/v1/database/$id/interests Aanmaken interesse
POST api.copernica.com/v1/database/$id/collections Aanmaken collectie
POST api.copernica.com/v1/database/$id/profiles Aanmaken nieuw profiel
PUT api.copernica.com/v1/database/$id/profiles Meerdere profielen tegelijk bewerken
POST api.copernica.com/v1/database/$id/views Aanmaken nieuwe selectie
PUT api.copernica.com/v1/view/$id Bewerken selectiegegevens
POST api.copernica.com/v1/view/$id/rules Aanmaken nieuwe selectieregel
POST api.copernica.com/v1/view/$id/views Aanmaken geneste selectie
PUT api.copernica.com/v1/rule/$id Bijwerken instellingen van selectieregel
POST api.copernica.com/v1/rule/$id/conditions Aanmaken nieuwe conditie bij selectieregel
PUT api.copernica.com/v1/profile/$id Bijwerken profielgegevens
PUT api.copernica.com/v1/profile/$id/fields Bijwerken profielvelden
POST api.copernica.com/v1/profile/$id/interests Toevoegen interesses van profiel
PUT api.copernica.com/v1/profile/$id/interests Overschrijven interesses van profiel
POST api.copernica.com/v1/profile/$id/subprofiles Toevoegen van een subprofielen aan een profiel
PUT api.copernica.com/v1/collection/$id Bijwerken collectiegegevens
POST api.copernica.com/v1/collection/$id/fields Aanmaken veld in een collectie
PUT api.copernica/com/v1/collection/$id/field/$id Bijwerken veld in collectie
POST api.copernica.com/v1/collection/$id/miniviews Aanmaken van een miniselectie
PUT api.copernica.com/v1/collection/$id/unsubscribe Bijwerken afmeldgedrag van een collectie
PUT api.copernica.com/v1/miniview/$id Bewerken miniselectiegegevens
POST api.copernica.com/v1/miniview/$id/rules Aanmaken nieuwe miniselectieregel
PUT api.copernica.com/v1/minirule/$id Bijwerken instellingen van miniselectieregel
POST api.copernica.com/v1/minirule/$id/conditions Aanmaken nieuwe conditie bij miniselectieregel

DELETE

DELETE methodes worden gebruikt om data te verwijderen. Dit is permanent, dus wees voorzichtig met welke calls je uitvoert. De volgende DELETE methodes zijn beschikbaar:

Methode Adres Omschrijving
DELETE api.copernica.com/v1/view/$id Verwijderen selectie
DELETE api.copernica.com/v1/rule/$id Verwijderen van een selectieregel
DELETE api.copernica.com/v1/profile/$id Verwijderen profiel
DELETE api.copernica.com/v1/subprofile/$id Verwijderen subprofiel
DELETE api.copernica.com/v1/collection/$id/field/$id Verwijderen veld in collectie
DELETE api.copernica.com/v1/miniview/$id Verwijderen miniselectie
DELETE api.copernica.com/v1/minirule/$id Verwijderen van een miniselectieregel