Developers

If you have configured the developer workflow for manually inviting developers, this covers the steps to add new developers

After you add a new developer account, you may wish to invite the developer users manually.

After completing these steps you will have added a new developer account for access to your API.

Step 1: Create the new developer account

From the Accounts page, create the new account. As an admin even some of the required fields can be skipped. If you want to invite users to the account securely, you can also skip the password fields. However the email on this main admin account must be unique among all users.

Create new developer account

Step 2: Set up applications

If you want to pre-configure app keys for the account, you can also continue to add an application on behalf of the developer. Otherwise you can leave this as one of the initial steps that the developer should take.

Add applications to new account

Step 3: Notify the developer

You can either send a manual email invite to the developer, or you can follow the optional steps to use the invite developer feature to send an invite.

If you choose to selectively invite developers or partners to join your API community you may also wish to disable the possibility for self-service signup in your portal.


When the signup workflow has been implemented with manual approval steps, you have several approaches to take action on approvals.

After this section you will be able to make approvals for any step in the signup workflow.

The approval step is slightly different depending on the trigger and what is being approved. If you receive an email notification then follow the next step. Otherwise choose the steps depending on whether you want to approve an account, service or application.

If you receive an email (as admin) notification that one of your developers has an item pending approval, you can copy/paste the URL for the item into your browser. This will take you directly to the page to make the approval.

From the Accounts page, you can search for specific accounts, or filter all accounts which are in a “pending” (for approval) state. Individual approvals can be made directly on each row, or you can select several rows at a time, and then perform a bulk approval.

HowTo developer approval account signup

From the Service Subscriptions page, you can search for specific subscriptions to a service, or filter all subscriptions which are in a “pending” (for approval) state. Then you can select one or several subscriptions at a time, and perform a bulk approval.

HowTo developer approval service subscription

From the Applications page, you can search for applications, or filter all applications which are in a “pending” (for approval) state. Then you can select one or several applications at a time, and perform a bulk approval.

HowTo developer bulk approvals apps

Another scenario is to start from the details page for a developer Account. From there you select which application you wish to approve. On the application details page, you can make the approval.

HowTo developer individual app approval 1
HowTo developer individual app approval 2

As admin you may change plans for a developer at any time, or in response to a plan change request that the developer initiates.

After this section you will be able to change plans for accounts, services or applications

The change plans step is slightly different depending on what type of plans are being changed.

From the Accounts page, you can search or filter specific accounts. Then you can select one or more rows at a time, and change the plans.

HowTo-developer change account plans

From the Service Subscriptions page, you can search or filter specific subscriptions to a service. Then you can select one or several subscriptions at a time, and change the plans.

HowTo developer change service plans

From the Applications page, you can search or filter specific applications. Then you can select one or several applications at a time, and change plans.

HowTo developer change app plans bulk

Another scenario is to start from the details page for a developer Account. From there you select the application for which you wish to change plan. On the application details page, you can change the plan.

HowTo developer change app plans individual

If rather than change to another standard plan, you only want to make a change for one specific app, you can use the customize plans feature.


Signup workflows are a critical aspect of the developer experience for your portal. The workflows can range from completely automatic and self-service to the other extreme of complete control with approval over who gains access and with what granularity.

At the end of the section you will understand which are the settings to adjust the signup workflows.

The 3scale system allows you to model your API with a combination of account, service (optional) or application plans. For each of these plans you can control whether there is an approval gate which you control. Also for each, you determine if there is a default, or the developer is required to take the next step and make a choice.

For the extreme of maximum automation and self-service, you want to remove all approval steps, and enable all possible default plans. This way immediately after signup, a key can be issued to provide access to your API.

HowTo developer workflow account plan defaults

HowTo-developer workflow service plan

HowTo developer workflow app plan

Once you have made the desired settings, test out the results, by going to your public portal, and attempting the steps to sign up as a new developer. Experiment and make any necessary adjustements to get exactly the right workflow for your API. When you are happy with the workflow, it is a good time to make sure that the email notifications provide the right content with the right context to your developers.

HowTo developer workflow email templates


Application plans are a good way to apply standard policies for different segement of your developer community. However you always have the flexibility to customize the standard plans for any indiviual developer with unique requirements.

When you have completed this section you will have customized an application plan for a specific developer.

Once a plan is customized, you lose the link to the original plan. If you make changes to the original plan, the custom plan does not inherit any of those changes. So you should use this customization power sparingly, before you get overwhelmed with too many custom plans which you cannot manage effectively.

First you should view the details page for the developer Account you are interested in.

HowTo developer customize plans select account

Select the application whose plan you wish to customize.

HowTo developer customize plans select app

Select the option to “customize”. This provides the page where all the plan elements can be customized for this application owned by this account.

HowTo developer customize plans

Before you take the step to customize plans, always consider first if you are not better off with a new standard plan (which can be hidden from display in the public portal). Then you would just change to the standard plan and so gain the benefit of reuse if this applies to more than one of your developer partners.


The workflow for developers may be configured to be self-service or manually invited by your admins. Self-service sign ups are done by developers through the portal, while manual invites are handled via the admin console.

After the configuration of developer sign up, you will have implemented self-service or manual mode.

HowTo developer enable signup

When developer accounts are created manually, you can invite developer users to that account

Normally this would be the first step after you create a developer account manually. If you have self-service signup, then you normally will not need to use this capability.

After completing these steps you will have added a new developer user for a developer account.

From the detailed account page for a developer, select “invitations”, and then “invite a user”.

HowTo developer invite user


When you allow developers to sign up for your API, you will probably want to get them to agree to some terms and conditions as well as make some of your policies clear before you grant them access.

There might be different types of Terms and Conditions you want your developers to abide by and these can be easily set up at different points during their registration.

  1. Sign up T&Cs
  2. Application T&Cs
  3. Service/Subscription T&Cs (only available when you have multiple services)

Additionally, if you are charging for your API you might want to make your Credit Card Policies explicit. 3scale provides you with a way to easily set up the following kinds of Credit Card Policy urls:

  1. Legal Terms
  2. Privacy
  3. Refunds

Let’s get started with the Terms and Conditions first.

This part of the workflow can be easily set up in 3scale by following the below steps.

From your Dashboard, go to Settings > Legal Terms

You will be presented with a blank page. To populate with your Signup Legal terms. You can use any combination of HTML, Javascript and CSS, but we provide some toggling code for you by clicking “Insert toggling code.” The content you place in this box will appear just above the “Sign Up” button on the Sign Up page for your developer portal.

HowTo T&Cs Legal Terms

Once you have filled out your Terms and Conditions you should save them by clicking “Update”

If you have used the toggling code, this will display the following text: “By signing up you agree to the following Legal Terms and Conditions” followed by a link that toggles showing/hiding the terms and conditions you have specified.

HowTo T&Cs Toggle link

This is placed on the Sign up page by default, but, in the end, this is just a partial (signuplicence) that can be included anywhere on your CMS. To remove this from the Signup page you just need to remove the {% include 'signuplicence' %} line from the page. Similarly if you want to include this elsewhere on your portal you can use the same partial by the “snippet” can be placed anywhere on your developer portal.

Additionally, you might also want your users to accept another set of T&Cs when they create a new application (newapplicationlicence Partial) and/or when they subscribe to a new service (servicesubscriptionlicence Partial.) You can follow the same procedure outlined above to set these up.

Let’s turn our attention to the Credit Card Policies now.

3scale allows you to define various different urls where you wish your different Policies to reside. You can set these up by going to your Dashboard > Settings > Policies and setting up the path where your Policy pages will be located.

HowTo T&Cs CC Policies

In order for these links to work, you will then need to create new pages in the CMS.

HowTo T&Cs Policy URLs

Once that is done, you can reference them using the Urls liquid drop. e.g

<a href="{{ urls.credit_card_terms }}">Legal Terms</a>
<a href="{{ urls.credit_card_privacy }}">Privacy</a>
<a href="{{ urls.credit_card_refunds }}">Refunds</a>

And that’s it!