Roles

API Key Roles

The following roles are available for API keys, depending on the needs of the developer:

  • IDX. This key provides access to two separate permission levels: IDX and portals.   IDX access requires that the agent purchase an API key, and from a technical aspect requires use of the flexmls API authentication. Portal access requires use of portal OAuth authentication, which makes the agent’s customer enter their username and password to sign in. Documentation on this site will refer to the “IDX permission” as the permission level within the IDX role that acts on behalf of an agent (without OAuth) and applies IDX rules, and the “portal permission” as the permission level within the IDX role that acts on behalf of an agent’s client (with OAuth) and applies IDX rules.
  • Private. This key requires use of OAuth to gain access to the agent’s information and private listing data.
For some examples, the IDX role is right for your application if you’re building an agent website to display IDX data, or want to build features for the agent’s customers. The private role is right if you’re building an application that an agent will use.
Roles may be downgraded as well using the RoleOverride parameter on any request along with a value of either Public or Idx. For example, users of a Private role may downgrade to public or IDX roles. This is useful for applications that interact with consumers using a higher-permission key, simplifying the number of keys that are necessary to create the application.

Comments on this entry are closed.