Collecting and Submitting Form Information

After determining the scopes your application requires, collect the information Yahoo! needs to issue a Consumer Key to the fourth party. You can achieve this through an HTML form that uses a POST method to submit the required information to the following URL endpoint:

http://developer.apps.yahoo.com/projects/createconsumerkey

The form submission must trigger a pop-up window that displays the above URL endpoint, where Yahoo! provides Yahoo! Information in one of two ways:

  1. Displays Yahoo! Information that the user must manually copy and paste into the form.

    OR

  2. Automatically provides Yahoo! Information to the developer return_to endpoint provided with your form.

Important

The pop-up window that you display must be 545 pixels wide and 650 pixels high as shown in the following code snippet:

For an example of how the form can look, refer to the following diagram, which shows both methods of providing the Consumer Key:

Create Consumer Key Form and Pop-up Window

Figure 2.1. Create Consumer Key Form and Pop-up Window


Here is an example form along with sample values you can use in the form:

Some required information that you must collect in the form includes:

  • Application Name: An identifiable name that your user will expect to see in their Yahoo account.
  • Name of Third Party: Your name as it appears to your users when they are asked to grant permission to their user data.
  • Scopes: The scopes (permissions) your application for which is requesting access.
  • Domain: The domain where the fourth party will install your application.

For more information on each of these required parameters, refer to the Parameter Reference in this guide.

Tip

Yahoo! provides button images that you can use for the submit button on your form. You can use these buttons, labeled "Get Yahoo! Information" and "Update Yahoo! Information," to create and update Consumer Keys, respectively.

Tip

If your application uses multiple scopes, you can specify more than one through a comma separated string as follows:

yprs,ycr

For more information on all the available fields, as well as those that are required with each scope, refer to Create Consumer Key API Reference.

Table of Contents