PHP Classes

File: doc/examples/webservice/resources/api.profiles.ini

Recommend this page to a friend!
  Classes of Kristo Vaher   Wave Framework   doc/examples/webservice/resources/api.profiles.ini   Download  
File: doc/examples/webservice/resources/api.profiles.ini
Role: Auxiliary data
Content type: text/plain
Description: Example Profiles
Class: Wave Framework
MVC framework for building Web sites and APIs
Author: By
Last change: removed references to
Date: 10 days ago
Size: 1,669 bytes


Class file image Download
; Web Service Tutorial <> ; Tutorial API Profiles ; ; This file stores an array of API profile names and their secret keys and other configuration ; options. When API is called with an API profile that is from this list and is not set as ; public in framework Configuration, then this API profile has to be authenticated with either ; a secret key or a session token. Every API profile is a group in this file, it's name written ; in brackets, followed by various settings for the API profile. ; ; Settings for both public and non-public profiles: ; * disabled - A true or false setting whether this profile is disabled ; * ip - Either aterisk (*) or comma separated list of allowed IP addresses ; * commands - Comma-separated list of commands allowed by this API, can be '*' to allow all commands ; ; Settings that are valid for non-public profiles only: ; * secret-key - Secret key of the API profile, should be a 32 character string for best security. ; * token-timeout - Time (in seconds) how long a generated token is valid if left unused. Default is infinite. ; * timestamp-timeout - This sets for how many seconds from the moment request was made this request is considered valid. ; * hash-validation - If this is set to 0 (it is set to 1 by default), then hash-based validations are not used at all. ; ; @package API ; @author Kristo Vaher <> ; @copyright Copyright (c) 2012, Kristo Vaher ; @license Unrestricted ; @tutorial /doc/pages/api_security.htm ; @since 1.0.0 ; @version 1.0.0 [public] disabled=0 ip="*" commands="movies-add,movies-delete,movies-get,movies-all"