De REST API

Met de REST API kun je automatische koppelingen met Copernica maken. Je kunt bijvoorbeeld je website of app zo programmeren dat hij met behulp van de REST API gegevens in je Copernica-account ophaalt, creëert, updatet of verwijdert. 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:

Methode Adres Omschrijving
GET api.copernica.com/v1/identity Opvragen identiteit van API koppeling
GET api.copernica.com/v1/databases Opvragen databases
POST api.copernica.com/v1/databases Aanmaken nieuwe database
GET api.copernica.com/v1/database/$id Opvragen databasegegevens
PUT api.copernica.com/v1/database/$id Bijwerken databasegegevens
DELETE api.copernica.com/v1/database/$id Verwijderen database
GET api.copernica.com/v1/database/$id/unsubscribe Opvragen afmeldalgoritme
PUT api.copernica.com/v1/database/$id/unsubscribe Instellen afmeldalgoritme
GET api.copernica.com/v1/database/$id/fields Opvragen databasevelden
POST api.copernica.com/v1/database/$id/fields Aanmaken databaseveld
PUT api.copernica.com/v1/database/$id/field/$id Veld uit database bijwerken
DELETE api.copernica.com/v1/database/$id/field/$id Veld uit database verwijderen
GET api.copernica.com/v1/database/$id/interests Opvragen interesses
POST api.copernica.com/v1/database/$id/interests Aanmaken interesse
GET api.copernica.com/v1/database/$id/collections Opvragen collecties
POST api.copernica.com/v1/database/$id/collections Aanmaken collectie
GET api.copernica.com/v1/database/$id/profiles Opvragen profielen
POST api.copernica.com/v1/database/$id/profiles Aanmaken nieuw profiel
PUT api.copernica.com/v1/database/$id/profiles Meerdere profielen tegelijk bewerken
GET api.copernica.com/v1/database/$id/profileids Opvragen profiel identifiers
GET api.copernica.com/v1/database/$id/views Opvragen selecties
POST api.copernica.com/v1/database/$id/views Aanmaken nieuwe selectie
GET api.copernica.com/v1/view/$id Opvragen selectiegegevens
PUT api.copernica.com/v1/view/$id Bewerken selectiegegevens
DELETE api.copernica.com/v1/view/$id Verwijderen selectie
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
POST api.copernica.com/v1/view/$id/rules Aanmaken nieuwe selectieregel
GET api.copernica.com/v1/view/$id/rule/$id Opvragen selectieregel
GET api.copernica.com/v1/view/$id/views Opvragen geneste selecties
POST api.copernica.com/v1/view/$id/views Aanmaken geneste selectie
GET api.copernica.com/v1/rule/$id Opvragen instellingen van selectieregel
PUT api.copernica.com/v1/rule/$id Bijwerken instellingen van selectieregel
DELETE api.copernica.com/v1/rule/$id Verwijderen van een selectieregel
GET api.copernica.com/v1/rule/$id/conditions Opvragen van selectieregels
POST api.copernica.com/v1/rule/$id/conditions Aanmaken nieuwe conditie bij selectieregel
GET api.copernica.com/v1/profile/$id Opvragen profielgegevens
PUT api.copernica.com/v1/profile/$id Bijwerken profielgegevens
DELETE api.copernica.com/v1/profile/$id Verwijderen profiel
GET api.copernica.com/v1/profile/$id/fields Opvragen profielvelden
PUT api.copernica.com/v1/profile/$id/fields Bijwerken profielvelden
GET api.copernica.com/v1/profile/$id/interests Opvragen interesses van profiel
POST api.copernica.com/v1/profile/$id/interests Toevoegen interesses van profiel
PUT api.copernica.com/v1/profile/$id/interests Overschrijven interesses van profiel
GET api.copernica.com/v1/profile/$id/subprofiles Opvragen subprofielen van een profiel
POST api.copernica.com/v1/profile/$id/subprofiles Toevoegen van een subprofielen aan een profiel
GET api.copernica.com/v1/collection/$id Opvragen collectiegegevens
PUT api.copernica.com/v1/collection/$id Bijwerken collectiegegevens
GET api.copernica.com/v1/collection/$id/fields Opvragen velden in een collectie
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 colectie
DELETE api.copernica.com/v1/collection/$id/field/$id Verwijderen veld in collectie
GET api.copernica.com/v1/collection/$id/miniviews Opvragen miniselecties onder een collectie
POST api.copernica.com/v1/collection/$id/miniviews Aanmaken van een miniselectie
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
PUT api.copernica.com/v1/collection/$id/unsubscribe Bijwerken afmeldgedrag van een collectie
GET api.copernica.com/v1/miniview/$id Opvragen miniselectiegegevens
PUT api.copernica.com/v1/miniview/$id Bewerken miniselectiegegevens
DELETE api.copernica.com/v1/miniview/$id Verwijderen miniselectie
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
POST api.copernica.com/v1/miniview/$id/rules Aanmaken nieuwe miniselectieregel
GET api.copernica.com/v1/miniview/$id/rule/$id Opvragen miniselectieregel
GET api.copernica.com/v1/minirule/$id Opvragen instellingen van miniselectieregel
PUT api.copernica.com/v1/minirule/$id Bijwerken instellingen van miniselectieregel
DELETE api.copernica.com/v1/minirule/$id Verwijderen van een miniselectieregel
GET api.copernica.com/v1/minirule/$id/conditions Opvragen van condities van een miniselectie
POST api.copernica.com/v1/minirule/$id/conditions Aanmaken nieuwe conditie bij miniselectieregel
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