Page 1 of 11
uCoz Community » Additional Services » PHP and API on uCoz » Basic API in uCoz (How to use basic API)
Basic API in uCoz
Natashko
Posts: 3366
Reputation: 170
Message # 1 | 3:21 PM
How to use basic API

GENERAL INFORMATION

Basic API is an interface of data receiving from the pages of a user's website. It is a GET-only interface that allows to receive only data (pages) of website modules, i.e. it works with guest (unauthorized user) permissions. At the moment it is available in 11 modules: blog, board, dir, gb, load, news, photo, publ, stuff, forum, index. To enable API, go to Control Panel -> Settings -> Common Settings -> Allow API usage.



It is disabled by default.


HOW TO USE

The format of the data, given to API is XML-RPC. All requests to the interface are performed by means of GET requests. You can use the function as follows:

http://SITE_ADDRESS/api/MODULENAME/ANYRELPATH

where:
SITE_ADDRESS – the URL of a user's website where API is used;
MODULENAME – website module;
ANYRELPATH – any module page where API usage is allowed.

So it is actually enough to add /api/ between the website address and the name of the module to use the interface (if it is enabled for the website).

Example

For example, in order to receive a web page:

http://win.ucoz.com/news/contest_for_best_uid_me_profile/2013-12-18-17

it is enough to send a GET request to:

http://win.ucoz.com/api....2-18-17


Natashko
Posts: 3366
Reputation: 170
Message # 2 | 3:43 PM
DESCRIPTION OF THE RETURNED DATA

API returns the data for the following types of website module pages:

Page type Module
entry rating page blog, board, dir, load, news, photo, publ
user's entries page blog, board, dir, load, news, photo, publ, stuff
specific entry page blog, board, dir, load, news, photo, publ, stuff
entries per day page blog, news
entries per month page blog, news
entries from the category (album) page blog, board, dir, load, news, photo, publ, stuff
module main page blog, board, dir, load, news, photo, publ, stuff, gb, forum
list of topics with the users' posts page, specific post page, last posts in the topic page, topics with last posts page, list of participants page, topic page, forums page forum
user's information page,, reputation history, list of users,, reproofs history, users' comments page, страница материалов пользователя, online users list, inactive entries list index
For the entry page the structure is returned in the tag
Code
<struct>
with the list of fields: field name name
Code
<name>
and field value value
Code
<value>
for the pages with several entries the array of structures for each entry is returned in the tag
Code
<array>
Field name Value
BANCHANGE_NAME user that has set the reproof
BANCHANGE_PROFILE profile of the user who has set the reproof
BANCHANGE_REASON reason for the reproof
BANCHANGE_TIME time of the reproof
BANCHANGE_VALUE whether the reproof level was increased or reduced (-1/0/1)
CATEGORY_NAME entry category name
CATEGORY_URL link to the page of the entry category
COMMENTS_NUM number of comments
COMMENTS_URL link to the comments page
COMMENT_ANSWER answer to the comment
COMMENT_DATE comment date
COMMENT_LINK link to the comment
COMMENT_MESSAGE comment message
COMMENT_RATE comment rating
COMMENT_TIME time of the comment
COMMENT_USERIP IP address of the comment author
DATE date of entry creation
ENTRY_URL link to the entry page
FORUM_DESCR description of the forum section
FORUM_LINK link to the forum section
FORUM_NAME name of the forum section
LASTPOST_AUTHOR last post author
LASTPOST_AUTHORPROFILE last post author's profile
LASTPOST_LINK link to the last post
LASTPOST_TIME time of the last post
LASTTOPIC_LINK link to the last forum topic
LASTTOPIC_NAME name of the last forum topic
LOADS_NUM number of entry downloads
MATERIAL_ID entry identifier for the specific module
MESSAGE message or the short description of the entry
PHOTO_HEIGHT height of the image
PHOTO_SIZE size of the image
PHOTO_URL link to the image
PHOTO_WIDTH width of the image
POST_DATE post date
POST_DIRECTURL link to the post
POST_ID post identifier
POST_MESSAGE post message
POST_NUMBER post number
POST_TIME post time
POST_TIMESTAMP post time in the timestamp format
RATED number of entry rates
RATING entry rating
READS_NUM number of entry readings
REPCHANGE_ANSWER answer to the message when changing the reputation
REPCHANGE_ID identifier of the message about reputation change
REPCHANGE_NAME name of the author, who has changed the reputation
REPCHANGE_PROFILE profile of the author, who has changed the reputation
REPCHANGE_REASON reason for reputation change
REPCHANGE_REF link to the page, where the reputation has been changed
REPCHANGE_TIME time of reputation change
REPCHANGE_VALUE increase/reduce reputation(-1/0/1)
REPLIES_NUM number of replies
RUNS_NUM number of application runs
TIME time of entry creation
TIMESTAMP time of entry creation in the timestamp format
TITLE entry title (topic, name)
TOPIC_DESCR forum topic description
TOPIC_LINK link to the topic
TOPIC_NAME topic name
TOPIC_NUMS number of topics
TOPIC_PAGESNUM number of the pages in the topic
UNACTIVEBLOG_LINK link to inactive entries page in blog module
UNACTIVEBLOG_NUM number of inactive entries in blog module
UNACTIVEBOARD_LINK link to inactive entries page in board module
UNACTIVEBOARD_NUM number of inactive entries in board module
UNACTIVEDIR_LINK link to inactive entries page in dir module
UNACTIVEDIR_NUM number of inactive entries in dir module
UNACTIVEFAQ_LINK link to inactive entries page in faq module
UNACTIVEFAQ_NUM number of inactive entries in faq module
UNACTIVEGB_LINK link to inactive entries page in gb module
UNACTIVEGB_NUM number of inactive entries in gb module
UNACTIVELOAD_LINK link to inactive entries page in load module
UNACTIVELOAD_NUM number of inactive entries in load module
UNACTIVENEWS_LINK link to inactive entries page in news module
UNACTIVENEWS_NUM number of inactive entries in news module
UNACTIVEPHOTO_LINK link to inactive entries page in photo module
UNACTIVEPHOTO_NUM number of inactive entries in photo module
UNACTIVEPUBL_LINK link to inactive entries page in publ module
UNACTIVEPUBL_NUM number of inactive entries in publ module
UNACTIVESTUFF_LINK link to inactive entries page in stuff module
UNACTIVESTUFF_NUM number of inactive entries in stuff module
USERBLOGENTRIES_LINK link to user's entries page in blog module
USERBLOGENTRIES_NUM number of user's entries in blog module
USERBOARDENTRIES_LINK link to user's entries page in board module
USERBOARDENTRIES_NUM number of user's entries in board module
USERCOMMENTENTRIES_LINK link to user's comments page
USERCOMMENTENTRIES_NUM number of user's comments
USERDIRENTRIES_LINK link to user's entries page in dir module
USERDIRENTRIES_NUM number of user's entries in dir module
USERFORUMENTRIES_LINK link to user's entries page in forum module
USERFORUMENTRIES_NUM number of user's entries in forum module
USERLOADENTRIES_LINK link to user's entries page in load module
USERLOADENTRIES_NUM number of user's entries in load module
USERNEWSENTRIES_LINK link to user's entries page in news module
USERNEWSENTRIES_NUM number of user's entries in news module
USERPHOTOENTRIES_LINK link to user's entries page in photo module
USERPHOTOENTRIES_NUM number of user's entries in photo module
USERPUBLENTRIES_LINK link to user's entries page in publ module
USERPUBLENTRIES_NUM number of user's entries in publ module
USERSTUFFENTRIES_LINK link to user's entries page in stuff module
USERSTUFFENTRIES_NUM number of user's entries in stuff module
USER_AGE site user's age
USER_AOL site user's AOL
USER_AVATAR site user's avatar
USER_AWARDS site user's number of awards
USER_BANNEDTILL site user's date of unblocking
USER_BANRATING site user's rating of reproofs
USER_BIRTHDAY site user's date of birth
USER_CITY site user's city of residence
USER_COUNTRY site user's country of residence
USER_EMAIL site user's e-mail address
USER_GENDER site user's sex
USER_GROUPID site user's group identifier
USER_GROUPNAME site user's group name
USER_HOMEPAGE site user's home page
USER_ICQ site user's ICQ
USER_ID site user's/entry author identifier
USER_IPADDRESS site user's IP address
USER_ISVERIFIEDEMAIL whether the site user's e-mail address is checked
USER_LASTVISIT user's last date of visit
USER_LOGTIMESTAMP site user's last time of login in timestamp format
USER_MSN site user's MSN
USER_NAME site user's/entry author name (login)
USER_POSTSNUM site user's number of posts
USER_PROFILE site user's profile
USER_RANK site user's rank
USER_RANKNAME site user's rank name
USER_REGDATE site user's registration date
USER_REGTIMESTAMP site user's registration time in timestamp format
USER_REPUTATION site user's reputation
USER_SIGNATURE site user's signature
USER_STATUS site user's status
USER_UNETID site user's UNET identifier
USER_UNETPROFILE site user's UNET profile
USER_USERNAME site user's/entry author full name
USER_YAHOO site user's YAHOO
USER_ZODIAC site user's zodiacal sign
VIEWS_NUM number of entry views


ADDITIONAL INFORMATION

In the nearest future the possibility of API usage will be added to some other system modules. As new features arrive, the information about API usage will be added and updated here as well.

Natashko
Posts: 3366
Reputation: 170
Message # 3 | 4:28 PM
FULL TABLE OF FIELDS CORRESPONDENCE TO PAGES AND MODULES

Module
page(URL)
Fields
blog
entry rating page (http://USER_SITE/api/blog/*-*-*-*-14-*-*) line like: A.B/C, where A.B – is an average rating (A – integer part, B decimal fraction), C – number of rates
user's entries page (http://USER_SITE/api/blog/*-*-*-*-17-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
specific entry page (http://USER_SITE/api/blog/a-b-c-d-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
entries per day page (http://USER_SITE/api/blog/a-b-c-*-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE TIME
TIMESTAMP
entries per month page (http://USER_SITE/api/blog/a-b-*-*-*-*-*) MATERIAL_ID
TITLE
ENTRY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
TIME
TIMESTAMP
entries from the category page (http://USER_SITE/api/blog/a-*-b-*-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
module main page (http://USER_SITE/api/blog/) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
board
entry rating page (http://USER_SITE/api/board/*-*-*-*-3-*-*-*-*) line like: A.B/C, where A.B – is an average rating (A – integer part, B decimal fraction), C – number of rates
user's entries page (http://USER_SITE/api/board/*-*-*-*-17-*-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
specific entry page (http://USER_SITE/api/board/*-*-*-a-*-*-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
entries from the category page (http://USER_SITE/api/board/a-*-*-*-*-*-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
module main page (http://USER_SITE/api/board/) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
dir
entry rating page (http://USER_SITE/api/dir/*-*-*-*-3-*-*-*) line like: A.B/C, where A.B – average rating (A – integer part, B decimal fraction), C – number of rates
user's entries page (http://USER_SITE/api/dir/*-*-*-*-17-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
specific entry page (http://USER_SITE/api/dir/*-*-*-a-*-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
entries from the category page (http://USER_SITE/api/dir/a-*-*-*-*-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
module main page (http://USER_SITE/api/dir/) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
forum
forums page (http://USER_SITE/api/forum/a-*-*-*-*-*) FORUM_NAME
FORUM_DESCR
FORUM_LINK
TOPIC_NUMS
REPLIES_NUM
LASTTOPIC_NAME
LASTTOPIC_LINK
LASTPOST_AUTHOR
LASTPOST_AUTHORPROFILE
LASTPOST_LINK
LASTPOST_TIME
list of topics with the users' posts page (http://USER_SITE/api/forum/*-*-*-3-*-*) TOPIC_NAME
TOPIC_DESCR
TOPIC_LINK
TOPIC_PAGESNUM
FORUM_NAME
FORUM_LINK
REPLIES_NUM
VIEWS_NUM
USER_NAME
USER_PROFILE
LASTPOST_TIME
LASTPOST_LINK
LASTPOST_AUTHOR
LASTPOST_AUTHORPROFILE
specific post page (http://USER_SITE/api/forum/*-*-*-16-*-*) POST_ID
POST_NUMBER
POST_MESSAGE
POST_DATE
POST_TIME
POST_TIMESTAMP
POST_DIRECTURL
USER_NAME
USER_USERNAME
USER_ID
USER_GROUPID
USER_PROFILE
USER_AVATAR
USER_GROUPNAME
USER_RANKNAME
USER_REPUTATION
USER_BANRATING
USER_SIGNATURE
USER_STATUS
USER_AWARDS
USER_POSTSNUM
USER_IPADDRESS
last posts in the topic page (http://USER_SITE/api/forum/*-*-*-17-*-*) line like http://USER_SITE/forum/*-*-*#*
topics with last posts page (http://USER_SITE/api/forum/*-*-*-34-*-*) TOPIC_NAME
TOPIC_DESCR
TOPIC_LINK
TOPIC_PAGESNUM
FORUM_NAME
FORUM_LINK
REPLIES_NUM
VIEWS_NUM
USER_NAME
USER_PROFILE
LASTPOST_TIME
LASTPOST_LINK
LASTPOST_AUTHOR
LASTPOST_AUTHORPROFILE
list of participants page (http://USER_SITE/api/forum/*-*-*-35-*-*) USER_PROFILE
USER_UNETPROFILE
USER_GROUPNAME
USER_GROUPID
USER_RANKNAME
USER_REGDATE
USER_LASTVISIT
USER_BIRTHDAY
USER_ICQ
USER_AOL
USER_MSN
USER_YAHOO
USER_COUNTRY
USER_STATE
USER_CITY
USER_GENDER
USER_POSTSNUM
USER_USERNAME
USER_AVATAR
topic page (http://USER_SITE/api/forum/*-*-*-42-*-*) POST_ID
POST_NUMBER
POST_MESSAGE
POST_DATE
POST_TIME
POST_TIMESTAMP
POST_DIRECTURL
USER_NAME
USER_USERNAME
USER_ID
USER_GROUPID
USER_PROFILE
USER_AVATAR
USER_GROUPNAME
USER_RANKNAME
USER_REPUTATION
USER_BANRATING
USER_SIGNATURE
USER_STATUS
USER_AWARDS
USER_POSTSNUM
USER_IPADDRESS
module home page (http://USER_SITE/api/forum/) FORUM_NAME
FORUM_DESCR
FORUM_LINK
TOPIC_NUMS
REPLIES_NUM
LASTTOPIC_NAME
LASTTOPIC_LINK
LASTPOST_AUTHOR
LASTPOST_AUTHORPROFILE
LASTPOST_LINK
LASTPOST_TIME
gb
module home page (http://USER_SITE/api/gb/) MATERIAL_ID
MESSAGE
USER_NAME
USER_ID
DATE
TIME
TIMESTAMP
load
entry rating page (http://USER_SITE/api/load/*-*-*-*-3-*-*-*) line like: A.B/C, where A.B – average rating (A – integer part, B decimal fraction), C – number of rates
user's entries page (http://USER_SITE/api/load/*-*-*-*-17-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
LOADS_NUM
DATE
TIME
TIMESTAMP
user's entries page (http://USER_SITE/api/load/*-*-*-a-*-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
LOADS_NUM
DATE
TIME
TIMESTAMP
entries from the category page (http://USER_SITE/api/load/a-*-*-*-*-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
LOADS_NUM
DATE
TIME
TIMESTAMP
module main page (http://USER_SITE/api/load/) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
LOADS_NUM
DATE
TIME
TIMESTAMP
news
entry rating page (http://USER_SITE/api/news/*-*-*-*-15-*-*) line like: A.B/C, where A.B – average rating (A – integer part, B decimal fraction), C – number of rates
user's entries page (http://USER_SITE/api/news/*-*-*-*-17-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
specific entry page (http://USER_SITE/api/news/a-b-c-d-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
entries per day page (http://USER_SITE/api/news/a-b-c-*-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
entries per month page (http://USER_SITE/api/news/a-b-*-*-*-*-*) MATERIAL_ID
TITLE
ENTRY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
TIME
TIMESTAMP
entries from the category page (http://USER_SITE/api/news/a-*-b-*-*-*-*) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
module main page (http://USER_SITE/api/news/) MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
photo
entry rating page
(http://USER_SITE/api/photo/*-*-*-13-*-*-*-*)
line like: A.B/C,
where A.B – average rating (A – integer part, B decimal fraction),
C – number of rates
user's entries page
(http://USER_SITE/api/photo/*-*-*-17-*-*-*-*)
MATERIAL_ID
TITLE
MESSAGE
PHOTO_URL
PHOTO_HEIGHT
PHOTO_WIDTH
PHOTO_SIZE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COM MENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
specific entry page
(http://USER_SITE/api/photo/*-*-a-*-*-*-*-*)
MATERIAL_ID
TITLE
MESSAGE
PHOTO_URL
PHOTO_HEIGHT
PHOTO_WIDTH
PHOTO_SIZE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COM MENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
entries from the album page
(http://USER_SITE/api/photo/a-*-*-*-*-*-*-*)
MATERIAL_ID
TITLE
MESSAGE
PHOTO_URL
PHOTO_HEIGHT
PHOTO_WIDTH
PHOTO_SIZE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COM MENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
module main page
(http://USER_SITE/api/photo/)
MATERIAL_ID
TITLE
MESSAGE
PHOTO_URL
PHOTO_HEIGHT
PHOTO_WIDTH
PHOTO_SIZE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COM MENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATING
RATED
READS_NUM
DATE
TIME
TIMESTAMP
publ
entry rating page
(http://USER_SITE/api/publ/*-*-*-*-3-*)
line like: A.B/C,
where A.B – average rating (A – integer part, B decimal fraction),
C – number of rates
user's entries page
(http://USER_SITE/api/publ/*-*-*-*-17-*)
MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATIN G
RATED
READS_NUM
DATE
TIME
TIMESTAMP
specific entry page
(http://USER_SITE/api/publ/*-*-*-a-*-*)
MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATIN G
RATED
READS_NUM
DATE
TIME
TIMESTAMP
entries from the category page
(http://USER_SITE/api/publ/a-*-*-*-*-*)
MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATIN G
RATED
READS_NUM
DATE
TIME
TIMESTAMP
module main page
(http://USER_SITE/api/publ/)
MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATIN G
RATED
READS_NUM
DATE
TIME
TIMESTAMP
stuff
user's entries page
(http://USER_SITE/api/stuff/*-*-*-*-17-*-*-*-*)
MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATIN G
RATED
READS_NUM
RUNS_NUM
DATE
TIME
TIMESTAMP
specific entry page
(http://USER_SITE/api/stuff/*-*-*-a-*-*-*-*-*)
MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATIN G
RATED
READS_NUM
RUNS_NUM
DATE
TIME
TIMESTAMP
entries from the category page
(http://USER_SITE/api/stuff/a-*-*-*-*-*-*-*-*)
MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATIN G
RATED
READS_NUM
RUNS_NUM
DATE
TIME
TIMESTAMP
module main page
(http://USER_SITE/api/stuff/)
MATERIAL_ID
TITLE
MESSAGE
ENTRY_URL
CATEGORY_NAME
CATEGORY_URL
COMMENTS_NUM
COMMENTS_URL
USER_NAME
USER_ID
RATIN G
RATED
READS_NUM
RUNS_NUM
DATE
TIME
TIMESTAMP
index
user's information page
(http://USER_SITE/api/index/8-*-*-*-*)
USER_ID
USER_PROFILE
USER_GROUPID
USER_GROUPNAME
USER_USERNAME
USER_NAME
USER_GENDER
USER_EMAIL
USER_ISVERIFIEDEMA IL
USER_HOMEPAGE
USER_COUNTRY
USER_CITY
USER_ICQ
USER_AOL
USER_MSN
USER_YAHOO
USER_BIRTHDAY
USER_ZODIAC
USER_AGE
USER_IPADDRESS
U SER_BANNEDTILL
USER_RANK
USER_RANKNAME
USER_REPUTATION
USER_AWARDS
USER_REGTIMESTAMP
USER_LOGTIMESTAMP
USER_STATUS
USER_UNETPROFILE
U SER_UNETID
reputation history
(http://USER_SITE/api/index/9-*-*-*-*)
REPCHANGE_ID
REPCHANGE_ANSWER
REPCHANGE_VALUE
REPCHANGE_NAME
REPCHANGE_PROFILE
REPCHANGE_REF
REPCHANGE_TIME
REPCHAN GE_REASON
list of users
(http://USER_SITE/api/index/15-*-*-*-*)
USER_PROFILE
USER_UNETPROFILE
USER_GROUPNAME
USER_GROUPID
USER_RANKNAME
USER_REGDATE
USER_LASTVISIT
USER_BIRTHDAY
U SER_ICQ
USER_AOL
USER_MSN
USER_YAHOO
USER_COUNTRY
USER_STATE
USER_CITY
USER_GENDER
USER_POSTSNUM
USER_USERNAME
USER_AVATAR
reproofs history
(http://USER_SITE/api/index/21-*-*-*-*)
BANCHANGE_VALUE
BANCHANGE_NAME
BANCHANGE_PROFILE
BANCHANGE_TIME
BANCHANGE_REASON
users' comments page
(http://USER_SITE/api/index/34-*-*-*-*)
COMMENT_MESSAGE
COMMENT_DATE
COMMENT_TIME
COMMENT_LINK
COMMENT_RATE
COMMENT_ANSWER
COMMENT_USERIP
users' entries page
(http://USER_SITE/api/index/46-*-*-*-*)
USERFORUMENTRIES_NUM
USERFORUMENTRIES_LINK
USERCOMMENTENTRIES_NUM
USERCOMMENTENTRIES_LINK
USERBLOGENTRIES_NUM
USERBLO GENTRIES_LINK
USERNEWSENTRIES_NUM
USERNEWSENTRIES_LINK
USERPUBLENTRIES_NUM
USERPUBLENTRIES_LINK
USERLOADENTRIES_NUM
USERLOADENTRIES_LI NK
USERDIRENTRIES_NUM
USERDIRENTRIES_LINK
USERBOARDENTRIES_NUM
USERBOARDENTRIES_LINK
USERPHOTOENTRIES_NUM
USERPHOTOENTRIES_LINK
USERS TUFFENTRIES_NUM
USERSTUFFENTRIES_LINK
online users list
(http://USER_SITE/api/index/62-*-*-*-*)
USER_ID
USER_NAME
USER_AGE
USER_PROFILE
inactive entries list
(http://USER_SITE/api/index/85-*-*-*-*)
UNACTIVEPHOTO_NUM
UNACTIVEPHOTO_LINK
UNACTIVEBLOG_NUM
UNACTIVEBLOG_LINK
UNACTIVENEWS_NUM
UNACTIVENEWS_LINK
UNACTIVEP UBL_NUM
UNACTIVEPUBL_LINK
UNACTIVELOAD_NUM
UNACTIVELOAD_LINK
UNACTIVEDIR_NUM
UNACTIVEDIR_LINK
UNACTIVEBOARD_NUM
UNACTIVEBOARD_LINK
U NACTIVESTUFF_NUM
UNACTIVESTUFF_LINK
UNACTIVEFAQ_NUM
UNACTIVEFAQ_LINK
UNACTIVEGB_NUM
UNACTIVEGB_LINK
Cartman
Posts: 31
Reputation: 2
Message # 4 | 8:28 AM
Is there an example somewhere about the usage?
Natashko
Posts: 3366
Reputation: 170
Message # 5 | 3:55 PM
Gigabyte
Posts: 25
Reputation: 2
Message # 6 | 2:06 PM
Thank you very much! Very detailed and informative. up
Gigabyte Zone - [ ... One Family, One Goal; Making Your Life A "Byte" Easier! ... ]
Movies, Games, Applications, Music, Books and plenty more!
Cartman
Posts: 31
Reputation: 2
Message # 7 | 12:14 PM
As I'm not a premium user can I use this to show the last forum messages on my main page? (I know that there is a solution by informers to display the latest updtaed tpopics, but not the messages.)
If yes, how?
Natashko
Posts: 3366
Reputation: 170
Message # 8 | 10:18 AM
Cartman,
Quote (Cartman)
As I'm not a premium user can I use this to show the last forum messages on my main page?

You do not have to be a premium user to use API. Just enable it in: Control panel->Settings->Settings->Common Settings->Allow API usage.
With its help you will be able to achieve the results you need. Please refer to FULL TABLE OF FIELDS CORRESPONDENCE TO PAGES AND MODULES here: http://forum.ucoz.com/forum/37-13083-74517-16-1302276535
carloscompu
Posts: 246
Reputation: 1
Message # 9 | 4:25 PM
How do I make this work Im not an expert but I like its funtion
Sunny
Fortune-teller
Posts: 7986
Reputation: 421
Message # 10 | 2:37 PM
carloscompu, what exactly do you want to implement with this feature?
Please give informative titles to your threads and use search before posting your questions.
uCoz Community » Additional Services » PHP and API on uCoz » Basic API in uCoz (How to use basic API)
Page 1 of 11
Search: