API Overview

Introduction

Safe Creative API Web Services are accessible via a REST-like interface. The interface is rooted at http://api.safecreative.org/v2/ unless you are using the arena server that lives in the arena subdomain: http://arena.safecreative.org/v2/

• Access method
• Charset
• Parameters
• URL syntax
• Zime parameter
• Signature parameter
• Obtain the keys to use the API
• User Key callback URL
• User Key bringback URL
• Authkey: The user authorization
• Error handling
• About users
• About Works
• User management
• Building common URLs
• Paginated requests
• API Arquitecture

API functions reference

Generic methods

• version
• ztime
• authkey.create
• authkey.state

User management

• user.link
• user.modify
• user.unlink

Master tables

• user.licenses
• license.features
• user.countries
• user.profiles
• work.types
• work.types.tree
• work.languages

Works info

• work.get
• work.get.private
• work.list
• work.certificate
• work.download
• work.download.private

Work management

• work.upload.lookup
• work.upload.begin
• work.upload.chunk
• work.upload.commit
• work.register
• work.attachfile
• work.delete

Multiauthorship

• work.rightsholders.add
• work.rightsholders.list
• work.rightsholders.remove

Search

• search.byquery
• search.byfields
• search.byhash
• semantic.query

How to

• Register work uploading
• Register work via URL
• Register work with extended info
• Register work with relations
• Desktop Applications

Troubleshooting

• Signatures
• Charsets
• Callbacks