REST API Version 1
Warning: You are viewing the documentation for the old REST API. We recommend using version 2 of the REST API.
The REST API allows you to retrieve and update the data that is stored inside Copernica from out of your own website or app. You can write your own scripts that send requests and instructions to our servers to fetch this data or to update it. You can use this API to automatically synchronize the data in Copernica with your own system, without any human interference.
- Introduction: the REST api in a nutshell
- Send and receive HTTP requests
- Fancy OAuth2 links
- Setting up Copernica REST service
- REST events
REST API: method reference
The following table lists all methods that are accessible through HTTP GET, POST, PUT en DELETE.
GET methods are used to fetch data. The following GET methods are available:
See also the general article on events.
PUT & POST
PUT and POST methods are used to create and edit data. They are often very similar. If you can not find a POST method of what you are looking for there might be a PUT method to do it. It also works the other way around. The following PUT and POST methods are available:
DELETE methods are used to delete data. This is permanent, so always be careful and double check your calls. The following DELETE methods are available:
|DELETE||api.copernica.com/v1/database/$id/field/$id||Remove database field|
|DELETE||api.copernica.com/v1/rule/$id||Remove selection rule|
|DELETE||api.copernica.com/v1/collection/$id/field/$id||Remove collection field|
|DELETE||api.copernica.com/v1/minirule/$id||Remove miniselection rule|