For Use with Red Hat 3Scale 2.saas
Chapter 1. Adding Developers
These are the steps to add a new developer account for access to your API.
If you have configured the workflow to invite developers manually, this covers how to add new developers.
1.1. Step 1: Create the new developer account
On the Accounts page of your Admin Portal, create the new account. As an admin, you can skip even some of the required fields. 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.
1.2. Step 2: Set up applications
If you want to pre-configure app keys for the account, you can also add an application on behalf of the developer. Otherwise, leave this as one of the initial steps for the developer to take.
1.3. Step 3: Notify the developer
You can either send an email invitation to the developer manually or follow the steps to use the invite developer feature.
Chapter 2. Approving Developers
This section shows how to make approvals for any step in the signup workflow.
Once you’ve implemented the signup workflow with manual approval steps, you have a few options. The approval process is slightly different depending on the trigger and what is being approved. If you receive an email notification, follow the instructions in the following section. Otherwise, it depends on whether you want to approve an account, a service, or an application.
2.1. Approve from email notification
If you (as admin) receive an email notification that one of your developers has an item pending approval, you can copy/paste the URL for the item into your browser, and it will take you directly to the page to make the approval.
2.2. Account approval
From the Accounts page of your Admin Portal, you can search for specific accounts or filter all accounts that are in a “pending” (for approval) state. You can make individual approvals directly on each row, or select several rows at a time and perform a bulk approval.
2.3. Service approval
From the Service Subscriptions page, you can search for specific subscriptions to a service or filter all subscriptions that are in a “pending” (for approval) state. Then you can select one subscription or several at a time and perform a bulk approval.
2.4. Application approval
From the Applications page, you can search for applications or filter all applications that are in a “pending” (for approval) state. Then you can select one application or several at a time and perform a bulk approval.
You can also start from the details page for a developer account, select which application you wish to approve from there, and make the approval on the application details page.
Chapter 3. Changing Plans For An App
After this section you will be able to change plans for accounts, services or applications
As admin you may change plans for a developer at any time, or in response to a plan change request that the developer initiates.
The change plans step is slightly different depending on what type of plans are being changed.
3.1. Change Account Plans
From the Developers page, you can search or filter specific accounts. Then you can select one or more rows at a time, and change the plans.
3.2. Change Service Plans
From the Service Subscriptions page, which you can only view if you have enabled service plans from the settings 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.
3.3. Change Application 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.
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.
3.3.1. More Information
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.
Chapter 4. Contacting Developers
This guide explains how to find out which developer account manages a particular application and then communicate with them – both through 3scale and externally.
During API operations, you may urgently need to contact developers who are using your API.
4.1. Step 1: Locate the relevant application and account in the system
If you already know the account and developer who manages the application in question, you can navigate to their account from the Accounts tab as shown below.
If you only have the application ID or API key, you can use the search box on the Accounts tab to find the relevant account. More information on locating applications is available here.
4.2. Step 2: Send an internal messages to developers
Once you’re on the account profile page as shown below, click on the message icon.
The message created here will be sent both to the account system dashboard, where all developers on the account will see it, and by email to the people on the developer account who have admin status within the account.
4.3. Step 3: Contact by other means
If it’s an emergency and email is unlikely to be fast enough for your purposes, you can also use the contact information submitted by the developer at time of signup, which is available:
- On the company account page (general contact information but may include a phone number)
- Developer/user specific information on the users’ own file
Note that you can make contact phone numbers a required field upon signup.
Chapter 5. Customize Plans
When you have completed this section you will have customized an application plan for a specific developer.
Application plans are a good way to apply standard policies for different segments of your developer community. However, you always have the flexibility to customize the standard plans for any individual developer with unique requirements.
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 feature sparingly, before you become overwhelmed with too many custom plans which you cannot manage effectively.
A developer wants to increase their current limits without upgrading to the next pricing tier as the current billing period is already under way. A customization could be a good way to handle this situation by enabling the increase in limits and charging only the variable costs incurred. This would also help encourage an upgrade for the following billing month.
5.1. Step 1: Choose the account
First you should view the details page for the developer Account you are interested in.
5.2. Step 2: Select the application
Select the application whose plan you wish to customize.
5.3. Customize the application plan
Select the option to “customize”. This provides the page where all the plan elements can be customized for the application owned by this account.
5.3.1. More Information
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 Developer 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.
Chapter 6. Enable Signup
Configure developer signup by implementing self-service or manual mode.
You can configure the workflow for developers to be self-service or by manual invite only. Self-service signups are done by developers through the Developer Portal, while manual invites are handled by your admins through the Admin Portal.
All you have to do is change the checkbox toggle to signup enabled.
Chapter 7. Finding Applications
By the end of this guide, you’ll be able to quickly locate an application in the Dashboard based on either its name, an API key, or an application identifier.
During API operations, you may need to be able to find information on an application that is accessing your API quickly – either for support purposes, to change configuration, or potentially because the application is misbehaving and needs to be disabled.
7.1. Step 1: Get the information you need
To find an application, you need to know something about it – the name of the account it belongs to or the application’s name. If you have this, locating it is straightforward from the Accounts or Applications tab in the Dashboard. However you may have no information other than the application identifier or its API key, for example if you’re seeing this information in your own access logs.
If you’re searching by identifier then for the different authentication types, you need the following information:
- For API key-only authentication patterns: the API key
- For app ID and app key authentication patterns: the app identifier (search by app key is not supported)
- For OAuth authentication patterns: the client_id (search on the secret is not supported)
7.2. Step 2: Search for the application
Armed with whatever data you have, head to the Accounts area of the Dashboard, and use the search box (shown in the image below).
7.3. Step 3: Access application information
Once the results are returned, click on the application you’d like to access and you’ll be taken to that application’s homepage, which includes information such as that shown in the image below.
Chapter 8. Inviting Developers
After completing these steps, you will have added a new developer user to a developer account.
When you create a developer account manually, you can invite developer users to that account through the Admin Portal.
From Developers > Accounts page, select “invitations” and then “invite a user”.
Chapter 9. Suspending Applications
This guide explains how to disable all keys and access tokens for an application.
If an application is misusing your API and affecting other traffic, you may need to quickly suspend its operations before contacting the developer involved to ask them to amend their code or configuration.
9.1. Step 1: Find the application
You can find the application from the Accounts or Applications tabs or by searching as described here.
9.2. Step 2: Disable the application
Once you have located the application and see the application summary page, click the suspend icon below the name of the application. This action will immediately disable the application from the API and suspend all keys from working. Calls with these application keys will be rejected by the control system.
The application can be unsuspended using the same button once the problematic behavior has been rectified.
If you use caching in your agents, suspension may not be immediate but require a short timeout.
9.3. Step 3: Contact the developer
How you contact the developer of the application will depend on your workflow and policy. On the same page, you can click on the account name under the submenu, which will take you to the account view where you can identify the key administrator of the account that owns the application. You can contact them either by email or by clicking on the send message button as shown, which will generate a dashboard message for the user.
Chapter 10. Webhooks
By the end of this section, you’ll be able to configure and take action on the webhooks for your Developer Portal.
The use of webhooks allows you to tightly integrate 3scale with your back-office workflow. When specified events happen within the 3scale system, your applications will be notified with a webhook message, and you can use the data such as from a new account signup to populate your CRM system.
10.1. Introducing webhooks
A webhook is a custom HTTP callback triggered by an event. In the 3scale system, all the possible events are displayed as in the screenshot below.
When one of these events occurs, the 3scale system makes an HTTP (or HTTPS) request to the URI configured in the webhooks section. On your end, you can configure the listener to invoke some desired behavior such as event tracking.
The remaining two checkboxes on the screenshot turn on webhooks ("Webhooks are" switch) and allow webhooks to be fired by actions in the Admin Portal. The default behavior is to trigger webhooks only by actions triggered from within the Developer Portal. Bear in mind that this means not all events can be triggered.
10.2. Webhooks format
he format of the webhook is always the same. It makes a post to the endpoint with an XML document of the following structure:
<?xml version="1.0" encoding="UTF-8"?> <event> <type>application</type> <action>updated</action> <object> THE APPLICATION OBJECT AS WOULD BE RETURNED BY A GET ON THE ACCOUNT MANAGEMENT API </object> </event>
The <type> gives you the subject of the event such as "application", "account", etc. The <action> – what has been done such as "updated", "created", "deleted". Finally the <object> is the XML object itself in the same format that is returned by the Account Management API. To check this, you can use our interactive ActiveDocs.
If you need to provide assurance that the webhook was fired by 3scale, expose an HTTPS webhook URL and add a custom parameter to your webhook declaration in 3scale. For example: https://your-webhook-endpoint?someSecretParameterName=someSecretParameterValue. Decide on the parameter name and value. Then, inside your webhook endpoint, check for the presence of this parameter value.
If you want to experiment with the webhooks or troubleshoot issues, you may find RequestBin a great (and free) service to view the results of the webhooks: http://requestb.in/
If you experience an outage for your listening endpoint, you can recover failed deliveries. 3scale will consider a webhook delivered if your endpoint responds with a 200 code. Otherwise, it will retry 5 times with a 60 seconds gap. After any recovery from an outage, or periodically, you should run a check and if applicable clean up the queue. You can find more in the ActiveDocs for the two methods:
- Webhooks list failed deliveries
- Webhooks delete failed deliveries