CM

Need to document how to use API and give examples

Registered by Bassel Safadi on 2011-04-26

This can be at api.creationmix.com/guides

Blueprint information

Status:
Started
Approver:
rejon
Priority:
Essential
Drafter:
None
Direction:
Needs approval
Assignee:
Bassel Safadi
Definition:
New
Series goal:
None
Implementation:
Good progress
Milestone target:
None
Started by
rejon on 2011-04-29

Related branches

Sprints

Whiteboard

Started on http://api.creationmix.com/guides updating now in realtime

all working API routes need to be listed on the documentation page to get this signed off.

I will not move this forward.

Also, bassel, you need to list what needs to be completed in a new bug or blueprint.

it is not acceptable to close this without details of what is working and needs to be done.

Jon

####

So, what is listed on the http://api.creationmix.com is what is working. So all these are being versioned as 2011.05:

    Materials
        cm.materials.getRecent
        cm.materials.getPremium
        cm.materials.Search
    Artists
        cm.artist.getMaterials
    CC license types
        cm.licenses.by.getMaterials
        cm.licenses.by-nc.getMaterials
        cm.licenses.by-nd.getMaterials
        cm.licenses.by-sa.getMaterials
        cm.licenses.by-nc-nd.getMaterials
        cm.licenses.by-nc-sa.getMaterials

The rest should be versioned 2011.06 when ready.

Jon

####
I tested and documented the routes that are currently on http://api.creationmix.com/documentation

have much more locally but need to test and push, will be doing during the week. some of them can't be tested now because there is no enough data, so need the site to fill up a bit

here is a full list of the calls that exists and need testing:

● Read
○ cm.material.getExif
○ cm.material.getFavorites
○ cm.material.getInfo
○ cm.material.getGeoData
○ cm.material.getPrivacy
○ cm.material.getSafetyLevel
○ cm.material.getContentType
○ cm.material.getPrice

● Write
○ cm.material.setContentType
○ cm.material.setDates
○ cm.material.setMeta
○ cm.material.setPerms
○ cm.material.setSafetyLevel
○ cm.material.setTags
○ cm.material.addTags
○ cm.material.upload
○ cm.material.upload.checkStatus

● Group
○ cm.material.getAllContexts
○ cm.material.getContactsPhotos
○ cm.material.getContactsPublicPhotos
○ cm.material.getContext
○ cm.material.getCounts
○ cm.material.getPerms
○ cm.material.getRecent
○ m.material.getSizes
○ cm.material.getUntagged
○ cm.material.recentlyUpdated
○ cm.material.search

● materials.licenses
○ cm.materials.licenses.getInfo
○ cm.materials.licenses.setLicense

● materials.comments
○ cm.materials.comments.addComment
○ cm.materials.comments.deleteComment
○ cm.materials.comments.editComment
○ cm.materials.comments.getList

○ cm.materials.comments.getRecentForContacts
collections
○ cm.collections.getInfo
○ cm.collections.getTree
○ cm.collections.addPhoto
○ cm.collections.create
○ cm.collections.editMeta
○ cm.collections.editPhoto
○ cm.collections.editPhotos
○ cm.collections.getInfo
○ cm.collections.getList
○ cm.collections.getListForPhoto
○ cm.collections.getPhotos

activity
○ cm.activity.userComments
○ cm.activity.userMaterials

users
○ cm.users.getList
○ cm.users.getListRecentlyUploaded
○ cm.users.getPublicList

favorites
○ cm.favorites.add
○ cm.favorites.getList
○ cm.favorites.getPublicList
○ cm.favorites.remove

Artists
○ cm.artists.findByEmail
○ cm.artists.findByUsername
○ cm.artists.getInfo
○ cm.artists.getPhotos
○ cm.artists.getPhotosOf
○ cm.artists.getPublicGroups
○ cm.artists.getPublicPhotos
○ cm.artists.getUploadStatus

stats
○ cm.stats.getCollectionDomains
○ cm.stats.getCollectionReferrers
○ cm.stats.getCollectionStats
○ cm.stats.getCSVFiles
○ cm.stats.getPhotoDomains
○ cm.stats.getPhotoReferrers
○ cm.stats.getPhotosetDomains
○ cm.stats.getPhotosetReferrers
○ cm.stats.getPhotosetStats

○ cm.stats.getPhotoStats
○ cm.stats.getPhotostreamDomains
○ cm.stats.getPhotostreamReferrers
○ cm.stats.getPhotostreamStats
○ cm.stats.getPopularPhotos
○ cm.stats.getTotalViews

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.