Sign Up

Sign up for a platform account and learn about account privileges.

API Platform Version: 8.1 and later

Table of Contents

  1. Do I need an account?
  2. How do I sign up for a new account?
  3. How do I sign up using a social media provider ID?
  4. What are my account privileges?
  5. How do I log in?
  6. How do I log in if the platform Terms and Conditions change?
  7. How does the verification code work?
  8. Why does my login time out?

Do I need an account?

There is no need to sign up for an account to view public APIs. There is also much public content such as discussion boards. You can even view trouble tickets posted by members of our community. However, you must create an account on the platform in order to access APIs. With an account, you can establish a project, invite others to collaborate with you, test your app using the Test Client tool, and receive permission to commercially publish an app integrated with platform APIs.

Back to top

How do I sign up for a new account?

The Sign Up process for a new account involves specifying standard user profile and account information. You can also sign up using the login ID from one of your favorite social media providers (for example, Facebook or Google). See How do I sign up using a social media provider ID?

To sign up for a new account:
  1. On the Login / Sign-up link in at the top of the Home page, click Create an account! You can also click the Sign Up button on the left side of the Home page.
  2. On the Sign Up page, provide your user information and review the Terms and Conditions.
    • First Name, Last Name, Email, Password, and Confirm are required fields. Note: The First Name and Last Name represent your User ID. The User ID will display in the Logged In user area after you create your account and sign in.
    • Your password must be different from your User ID (First Name / Last Name), it must contain 8 to 20 characters, can contain alphanumeric characters, must include at least one letter and number, may include the following characters (%,&, _, ?, #, =, -), cannot contain spaces, and is not case sensitive. To ensure account integrity, using a "strong" password is recommended.
    • You might need to provide answers to one or more security challenge questions, depending on platform settings.
    • Accept Terms and Conditions provides rules and regulations for using the site. You can review the Terms and Conditions by clicking the link. After reviewing, click the check box to accept.
  3. To confirm your entries, click Next.
  4. The Check Your Email page displays indicating that a registration email has been sent to the specified email address.
    • The email contains a link that is used to activate your account.
    • Load the email and click the link to activate your account. The Finish page displays.
    • Note: Your activation email expires 7 days after being issued. If you activate an expired email, the Expired Registration Email page displays with a notice that a new email has been sent. Load the new email and continue with the activation process.
  5. Confirm the First Name, Last Name, and Email entries, then enter your Password and click Finish. The User Details page displays. Here you will verify your account information and configure an Avatar.
  6. Click Edit. The Edit User Details page displays.
    • Verify First Name and Last Name entries.
    • Update your User Name as needed. The User Name is used to display the author of posts and tickets on the App Forum, API Forum, or Dashboard.
  7. You can upload a profile avatar (image) via the Profile > Details page. Profile pic upload options include performing a direct file upload or uploading a file from Gravatar. For file requirements, see What are the file requirements for avatar images?
  8. To upload a new user profile pic (direct file upload):
    • Access the Edit User Details page (Profile > Details > Edit). The current profile pic displays in the Avatar section.
    • Click Upload. The Upload File pop-up displays.
    • Click Browse to target and select your profile pic image. Click Upload. The image loads into the Upload File pop-up with the upper left corner of the file selected. This represents the default crop setting for your image (75px x 75px). Select the cropped area and drag the highlight to the area of the image you would like to display as your profile pic. You can resize the cropped area as desired (but cannot exceed the default crop setting).
    • After you have defined the area of your image you would like cropped, click Save. After saving your user settings, your profile pic will be updated and will display in the Logged In User area, and with App Forum, API Forum, and Dashboard posts.
  9. To upload a new user profile pic (Product / Gravatar upload):
    • Access the Edit User Details page (Profile > Details > Edit). The current profile pic displays in the Avatar section.
    • If you would like to use the default product icon, select the Use Avatar option that displays the product name.
    • If would like to use an icon you have registered with https://en.gravatar.com/, select the Use Avatar from Gravatar icon. The avatar changes to the Gravatar icon.
    • After saving your user settings, your profile pic will be updated and will display in the Logged In User area, and with App Forum, API Forum, and Dashboard posts.
  10. Click Save. Click Settings in the left navigation. The User Settings page displays. Here you can update your Email and Password information and configure Email Notifications.
  11. Click Edit. The Edit User Settings page displays. Perform the following tasks:
    • Verify and update the Email address as needed.
    • If you would like to receive news updates, click the Receive Email Updates check box.
    • You can configure your account to receive notifications via email when certain activities occur. Click the check box for each activity you would like to receive notifications for. For details of notification settings, see How do I enable or disable email notifications?
  12. Click Save to commit changes, and Finish to complete the sign-up process. If one or more Email notification options are selected, the Receive Email Updates field displays Active. If no notification options are configured, the field displays Inactive.
  13. After committing changes, the system creates your user account and the top navigation is updated as follows:
    • Your login information is indicated with the configured Avatar followed by "Logged in as <First Name / Last Name>."
    • The Profile link is used to access your User Details and User Settings pages.
    • The Logout link is used to sign out.
    • The Dashboard section displays the number of unviewed notifications.
    • The Quick Filter section displays a set of icons for accessing site functionality. From left to right the icon legend is My APIs, My Apps, My Groups, and My Users.

See How do I edit my user profile? for more information.

Back to top

How do I sign up using a social media provider ID?

You can sign up using your favorite social media provider login ID to perform the initial sign up and for performing future logins. Supported social media providers include Facebook and Google.

To sign up using a social media provider ID:
  1. In the anonymous top navigation, click Create an account. The Sign-up page displays.
  2. In the Sign-up using external account section, click a social media icon (for example, Facebook or Google) and sign in using your credentials.
  3. After your login credentials have been accepted, you'll be redirected to the Finish page.
  4. Confirm the First Name, Last Name, and Email entries, then enter your Password and click Finish. The User Details page displays. Here you will verify your account information and configure an Avatar.
  5. Click Edit. The Edit User Details page displays.
    • Verify First Name and Last Name entries.
    • Update your User Name as needed. The User Name is used to display the author of posts and tickets on the App Forum, API Forum, or Dashboard.
  6. You can upload a profile pic image to the site via the Profile > Details page. Profile pic upload options include performing a direct file upload or uploading a file from Gravatar. For file requirements, see What are the file requirements for avatar images?
  7. To upload a new user profile pic (direct file upload):
    • Access the Edit User Details page (Profile > Details > Edit). The current profile pic displays in the Avatar section.
    • Select the Use Avatar option that displays the product name.
    • Click Upload. The Upload File pop-up displays.
    • Click Browse to target and select your profile pic image. Click Upload. The image loads into the Upload File pop-up with the upper left corner of the file selected. This represents the default crop setting for your image (75px x 75px). Select the cropped area and drag the highlight to the area of the image you would like to display as your profile pic. You can resize the cropped area as desired (but cannot exceed the default crop setting).
    • After you have defined the area of your image you would like cropped, click Save. After saving your user settings, your profile pic will be updated and will display in the Logged In User area, and with App Forum, API Forum, and Dashboard posts.
  8. To upload a new user profile pic (Gravatar upload):
    • Access the Edit User Details page (Profile > Details > Edit). The current profile pic displays in the Avatar section.
    • If would like to use an icon you have registered with https://en.gravatar.com/, select the Use Avatar from Gravatar icon. The avatar changes to the Gravatar icon.
    • After saving your user settings, your profile pic will be updated and will display in the Logged In User area, and with App Forum, API Forum, and Dashboard posts.
  9. Click Save. Click Settings in the left navigation. The User Settings page displays. Here you can update your Email and Password information and configure Email Notifications.
  10. Click Edit. The Edit User Settings page displays. Perform the following tasks:
    • Verify and update the Email address as needed.
    • If you would like to receive news updates, click the Receive Email Updates check box.
    • You can configure your account to receive notifications via email when certain activities occur. Click the check box for each activity you would like to receive notifications for. For details of notification settings, see How do I enable or disable email notifications?
  11. Click Save to commit changes, and Finish to complete the sign-up process. If one or more Email notification options are selected, the Receive Email Updates field displays Active. If no notification options are configured, the field displays Inactive.
  12. After committing changes, the system creates your user account and the top navigation is updated as follows:
    • Your login information is indicated with the configured Avatar followed by "Logged in as <First Name / Last Name>."
    • The Profile link is used to access your User Details and User Settings pages.
    • The Logout link is used to sign out.
    • The Dashboard section displays the number of unviewed notifications.
    • The Quick Filter section displays a set of icons for accessing site functionality. From left to right the icon legend is My APIs, My Apps, My Groups, and My Users.

See How do I edit my user profile? for more information.

Back to top

What are my account privileges?

If you signed up for an account you have privileges to create an application and utilize the full spectrum of development, application management, and collaboration features.

  • For the application projects you develop, you also are the sole administrator for the project.
  • As an administrator, you can invite developers who are account holders to join your application team.
  • Team members also have administrator rights for the app.

Back to top

How do I log in?

The top navigation includes a Login / Sign-up section that is used to log into the site.

To log in using your credentials:
  1. Click the Login / Sign-up link. The Login page displays.
  2. In the Login area, specify your Email and Password, and click Login.
  3. If the login is successful, your personal Dashboard page displays.
To log in using your third-party provider ID:

Note: once you set up a platform account with an email that's authenticated via a third-party provider such as Facebook or Google, you cannot create a platform account using that email address, and you can only reset your password via the same third-party provider.

  1. Click the Login / Sign-up link. The Login page displays.
  2. In the Sign-up using external account section, select the Facebook or Google icon and specify your login credentials. After your login credentials have been accepted you'll be redirected back to your personal Dashboard page.

Back to top

How do I log in if the platform Terms and Conditions change?

If the platform Terms and Conditions you reviewed and agreed to when you initially signed up to the platform change between logins, you will be required to review and agree to the new copy when you log in.

To log in using your credentials:
  1. Click the Login / Sign-up link. The Login page displays.
  2. In the Login area, specify your Email and Password, and click Login.
  3. If the Terms and Conditions have changed you'll see a Pending Signup Agreement popup. Use the vertical scroll bar to navigate through the Signup Agreement and review the text.
  4. Click Accept to accept the Terms and Conditions.
  5. If the login is successful, your personal Dashboard page displays.
To log in using your social media provider ID:
  1. Click the Login / Sign-up link. The Login page displays.
  2. In the Sign-up using external account section, select the Facebook or Google icon and specify your login credentials. After your login credentials have been accepted you'll be redirected back to the platform.
  3. If the Terms and Conditions have changed you'll see a Pending Signup Agreement popup. Use the vertical scroll bar to navigate through the Signup Agreement and review the text.
  4. Click Accept to accept the Terms and Conditions.
  5. If the login is successful, your personal Dashboard page displays.

Back to top

How does the login verification code work?

Some versions of the platform include an extra layer of login security. If that is the case, you'll be sent a special verification code by phone or email. The details depend on how the platform version you're using is set up; but basically you'll need to log in, providing your credentials in the usual way, and then provide the code.

Generally the code has quite a short life, perhaps five minutes. If you don't manage to log in before the code expires you can request a new one.

This extra layer of security helps protect you and your account, as well as the platform, from unauthorized users.

If you have any questions about the verification code, or the process, contact your Site Admin.

Back to top

Why does my login time out?

For security reasons, the developer portal might be set to time out. There are two timeout settings:

  • Timeout after a period of inactivity.
  • Timeout even if a user is still active but has been using the portal for an extended period of time.

The amount of session time that's allowed before the timeout occurs is controlled by the Site Admin.

If your session is active and reaches the maximum session time, you'll see a notification message prompting you to save your work. Save any change immediately so that you don't lose any work. There is no restriction on logging in again; you'll be able to log back in immediately after the timeout, or when you see the message you can simply log out and log back in again immediately.

Back to top