API Reference: Difference between revisions

From Safe Creative API
Jump to navigation Jump to search
w>Jguillo
No edit summary
m (40 revisions imported)
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Here you can find the complete reference for each of the functions available in the API
Here you can find the complete reference for each of the components available in the API, grouped by functionality.


= Authorization and validation =
You can also access an [[:Category:API component|alphabetical list of API components]] for quick reference of a particular component.
 
= Standard API =
== Authorization and validation ==
These functions are used for assistance in working with other functions
These functions are used for assistance in working with other functions
* [[version]]
* [[version]]
Line 7: Line 10:
* [[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
* [[user.licenses]]
* [[user.licenses]]
Line 16: Line 20:
* [[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]]
Line 22: Line 27:
* [[work.list]]
* [[work.list]]
* [[work.certificate]]
* [[work.certificate]]
* [[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 30: Line 35:
* [[work.upload.chunk]]
* [[work.upload.chunk]]
* [[work.upload.commit]]
* [[work.upload.commit]]
* [[work.uploadticket.status]]
* [[API upload servlet]]
* [[API upload servlet]]
* [[work.register]]
* [[work.register]]
* [[work.rights.register]]
* [[work.attachfile]]
* [[work.attachfile]]
* [[work.delete]]
* [[work.delete]]
= Multiauthorship =
 
== User info ==
To get data about users
* [[user.get]]
* [[user.get.private]]
* [[user.quota]]
 
== Multiauthorship ==
To register more rights holders for a work
To register more rights holders for a work
* [[work.rightsholders.add]]
* [[work.rightsholders.add]]
* [[work.rightsholders.confirm]]
* [[work.rightsholders.list]]
* [[work.rightsholders.list]]
* [[work.rightsholders.remove]]
* [[work.rightsholders.remove]]
= User management =
 
These functions allow to create and modify user accounts on Safe Creative. You must be a partner to use these functions
= Partners API =
You must be a partner to use these functions.
 
== Work download ==
* [[work.download]]
 
== User management ==
These functions allow to create and modify user accounts on Safe Creative.  
* [[user.link]]
* [[user.link]]
* [[user.modify]]
* [[user.modify]]
* [[user.unlink]]
* [[user.unlink]]
= Search =
* [[user.findbymail]]
To search for works. Search services are part of the public API and no application key is needed to use them.
* [[user.newsale]]
 
= Public API =
To search for works and query public registration data.  
 
These services are public and no application key is needed to use them.
 
== Public work info ==
* [[work.metadata.namespaces]]
* [[work.get]]
 
== Search ==
* [[search.byquery]]
* [[search.byquery]]
* [[search.byfields]]
* [[search.byfields]]
* [[search.byhash]]
* [[search.byhash]]
= Semantic services =
To get a work registration info from a digital fingerprint of its contents.
* [[semantic.query]]
* [[semantic.query]]


= See also =
= See also =
Line 55: Line 92:
* [[How to]]
* [[How to]]
* [[Troubleshooting]]
* [[Troubleshooting]]
* [[API Wrappers]]

Latest revision as of 08:07, 7 May 2021

Here you can find the complete reference for each of the components available in the API, grouped by functionality.

You can also access an alphabetical list of API components for quick reference of a particular component.

Standard 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

User info

To get data about users

Multiauthorship

To register more rights holders for a work

Partners API

You must be a partner to use these functions.

Work download

User management

These functions allow to create and modify user accounts on Safe Creative.

Public API

To search for works and query public registration data.

These services are public and no application key is needed to use them.

Public work info

Search

Semantic services

To get a work registration info from a digital fingerprint of its contents.


See also