MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES, Use Manual

Page: 18 / 196

18 Chapter 1: Architecture Overview
To successfully call an action, you must supply both an access key and the cookie for a logged-in
user who has the permissions to call that action. If you don’t supply both credentials (for example,
if you supply the cookie for a user who doesn’t have the right permissions), the action fails.
Your application can log in multiple users and can call actions for any of those users. For example,
when an ordinary user is using your application, you may want to authenticate as that user and
call actions using that user’s credentials, while also keeping an administrative user logged in to
perform tasks that require higher levels of permissions.
For information about the possible status codes that the server can return, see the
status
tag.
Access keys for Macromedia Breeze hosted (ASP) customers
Note: In Breeze 4.1, you no longer need an access key to call actions. However, passing the
accesskey
parameter in Breeze 4.1 is not harmful, it is ignored.
By default, your account is not enabled for XML web services. You must contact Macromedia
technical support to obtain a valid XML access key to use with each action.
To contact technical support, go to the Breeze support page ( www.macromedia.com/support/
breeze/ ) and request that an XML access key be generated for your account.
Access keys for Macromedia Breeze Enterprise (licensed) customers
Note: In Breeze 4.1, you no longer need an access key to call actions. However, passing the
accesskey
parameter in Breeze 4.1 is not harmful, it is ignored.
Your server installation initially has no XML access key. You must add an access key before you
can use the XML web services.
To add an access key:
1.
Locate the custom.ini file, in the breeze subdirectory of the installation directory.
2.
Add a parameter at the end of the file by typing the following text on a new line:
XML_API_KEY=
3.
Immediately after the equal sign (=), on the same line, type an access key of your choice. The
key should be 16 characters and should be a combination of numbers and letters. Access keys
are case-sensitive.
4.
Stop the Breeze server, and then restart it.
About permissions
Permissions define the ways in which a particular principal can interact with a given SCO.
A permission mapping, indicating what permissions a particular principal has for a particular
SCO, is called an
ACL . An ACL consists of three pieces of information: the ID of a SCO (usually
referred to in this context as an ACL ID), the ID of a principal, and a keyword that indicates what
the permissions are (usually referred to as a permission ID).
There are two kinds of permissions in Breeze: permissions associated with specific SCOs, and
permissions that belong to all users who are members of special groups that are called primary
groups. Permissions for primary groups take precedence over the permissions set on a SCO.