API Reference: Difference between revisions

From Safe Creative API
Jump to navigation Jump to search
w>Jguillo
No edit summary
w>Jguillo
No edit summary
Line 7: Line 7:
* [[authkey.create]]
* [[authkey.create]]
* [[authkey.state]]
* [[authkey.state]]
= Master tables =
= Master tables =
To query values for fixed data (licenses, work types,...) used as parameters in other functions
To query values for fixed data (licenses, work types,...) used as parameters in other functions
Line 16: Line 17:
* [[work.types.tree]]
* [[work.types.tree]]
* [[work.languages]]
* [[work.languages]]
= Works info =
= Works info =
To get data about works, download them or get registration certificates
To get data about works, download them or get registration certificates
* [[work.get]]
* [[work.get.private]]
* [[work.get.private]]
* [[work.list]]
* [[work.list]]
Line 24: Line 25:
* [[work.download]]
* [[work.download]]
* [[work.download.private]]
* [[work.download.private]]
= Work management =
 
= Works management =
To upload, register and delete works
To upload, register and delete works
* [[work.upload.lookup]]
* [[work.upload.lookup]]
Line 34: Line 36:
* [[work.attachfile]]
* [[work.attachfile]]
* [[work.delete]]
* [[work.delete]]
= Multiauthorship =
= Multiauthorship =
To register more rights holders for a work
To register more rights holders for a work
Line 39: Line 42:
* [[work.rightsholders.list]]
* [[work.rightsholders.list]]
* [[work.rightsholders.remove]]
* [[work.rightsholders.remove]]
= User management =
= User management =
These functions allow to create and modify user accounts on Safe Creative. You must be a partner to use these functions
These functions allow to create and modify user accounts on Safe Creative. You must be a partner to use these functions
Line 44: Line 48:
* [[user.modify]]
* [[user.modify]]
* [[user.unlink]]
* [[user.unlink]]
= Search =
 
To search for works. Search services are part of the public API and no application key is needed to use them.
= Public API =
To search for works and get public registration data.  
These services are public and no application key is needed to use them.
* [[work.get]]
* [[search.byquery]]
* [[search.byquery]]
* [[search.byfields]]
* [[search.byfields]]

Revision as of 15:41, 5 May 2010

Here you can find the complete reference for each of the functions available in the API

Authorization and validation

These functions are used for assistance in working with other functions

Master tables

To query values for fixed data (licenses, work types,...) used as parameters in other functions

Works info

To get data about works, download them or get registration certificates

Works management

To upload, register and delete works

Multiauthorship

To register more rights holders for a work

User management

These functions allow to create and modify user accounts on Safe Creative. You must be a partner to use these functions

Public API

To search for works and get public registration data. These services are public and no application key is needed to use them.

See also