Chapter 1. First steps with 3scale API Management

Procedure

1. Run the wizard. You can run the 3scale wizard in two ways:

   • The first time you log in to your 3scale account.

   • Running the wizard by replacing your_admin_domain in the following URL address:

     https://<your_admin_domain>-admin.3scale.net/p/admin/onboarding/wizard/intro

     For example, if your admin domain is testing-area, the wizard is available in:

     https://testing-area-admin.3scale.net/p/admin/onboarding/wizard/intro

2. Click OK, how does 3scale work?.
3. Watch the introductory animation. Once done, click Got it! Let’s add my API.

4. Create a backend:

   1. Specify a name for your backend. For example: Inventory
   2. Indicate a base URL for the backend. Example: https://echo-api.3scale.net:443
   3. Click Add this Backend.

5. Create a product:

   1. Indicate a product name. For example: Petstore
   2. Click Add this Product.

6. Indicate a path to connect your backend to your product, and click Add the Backend to the Product.

   • You can leave the default value. Path: /

7. To make a test with a GET request, click Send request.

   • You can specify a GET method.
8. After these steps, you will see a confirmation of a successful request to the API Gateway. For more details about the following configurations, click Cool, what’s next?.

Procedure

1. Go to the Dashboard.
2. Under the APIs section, click Create Backend in the Backends card.

3. Provide the following details:

   • Name

     Backend identifier.

   • System name

     Identifier used for internal purposes.

   • Description

     Optional field containing more details about the backend.

   • Private Base URL

     Base URL endpoint of the private API.

4. Click Create Backend.

Procedure

1. Go to the Dashboard. Under the APIs section, click Create Product in the Products card.

2. Provide the following details:

   • Name

     Product identifier.

   • System name

     Identifier used for internal purposes. A product system_name is used to generate proxy endpoints and domain names. By default, system_name is part of a label whose pattern can be as one of the alternatives below:

     • For APIcast staging

       %{system_name}-%{tenant_name}-apicast-staging

     • For APIcast production

       %{system_name}-%{tenant_name}-apicast-production

   • When an auto-generated URL label exceeds 63 characters, the system shortens the label as follows: <truncated_label>-<unique_hash>

     • <truncated_label>

       The first 54 or 55 characters of the original URL.

     • <unique_hash>

       The first 7 characters of a unique SHA-1 hash calculated from the original label.

       For example, this is the URL before truncation:

       https://my-very-long-system-name-also-very-long-tenant-name-apicast-staging.3scale.net

       This is the URL after the truncation:

       https://my-very-long-system-name-also-very-long-tenant-name-api-72588d2.3scale.net

   • Description

     Optional field containing more details about the product.

3. Click Create Product.

Procedure

1. Navigate to [Your_product_name] > Integration > Backends.
2. Click Add Backend.

3. From the drop down list, perform one of these actions:

   • Select an existing backend.

   • Click View all to see the entire list.

     • If you need to create a new backend, click Create new Backend and complete the details.
4. Specify the routing path in the Path textbox. For more details, see The backend path of a specific product.
5. Click Add to Product.
6. Promote the product under the Products tab in [Your_product_name] > Integration > Configuration.

1. The application sends a request.
2. The request is sent to the public URL: <public-api-domain>/supplies/list
3. The backend path is removed before redirecting to the private URL: <private-api-domain>/list
4. The request is redirected to the Inventory backend.

Procedure

1. On the Dashboard, click the Backend you want to define mapping rules for.
2. In the navigation panel, click Mapping Rules.
3. Click Create mapping rule.

4. Specify the following settings:

   • Verb

     The HTTP request verb (GET, POST, DELETE, or PUT).

   • Pattern

     The pattern to match. For example, /hello.

   • Metric or method to increment

     The metric or method name.

   • Increment by

     The metric increment number. For example, 1.

   • Last?

     If the request matches a rule marked Last?, APIcast stops processing and will not search for matches in the remaining mapping rules, then also stops incrementing their metrics.

   • Position

     Number that indicates the position of the execution of the mapping rule, to sort the mapping rules.

5. Click Create mapping rule.

Procedure

1. Navigate to [Your_product_name] > Applications > Application Plans.
2. Click Create Application Plan.
3. On the Create Application Plan page, enter a name and a system name for your new plan. A system name must be unique in your 3scale installation.
4. Click Create Application Plan.

Procedure

1. Navigate to Audience > Accounts > Listing.
2. Click the default Developer account.
3. Click the Applications tab.
4. Click Create application.
5. In the Create application dialog, select the product for the application.
6. Choose an application plan.
7. Specify an application name.
8. In the Description field, enter information about this application.
9. Click Create application.

Procedure

1. Promote the new APIcast configuration to staging:

   1. Navigate to [Your_product_name] > Integration > Configuration.

   2. Under APIcast Configuration, click Promote v.[n] to Staging APIcast.

      • v.[n] indicates the version number to be promoted.
      • If there are no changes to be promoted, there is a grayed button with the text Nothing to promote.

2. Under Staging APIcast, promote the APIcast configuration to production by clicking Promote v.[n] to Production APIcast.

   • v.[n] indicates the version number to be promoted.
   • If there are no changes to be promoted, you will see a grayed button with the text Nothing to promote.

3. To test requests to your API product, copy the command provided in Example curl for testing and run it in a terminal.

   • The curl command example is based on the first mapping rule of the product.
   • After you run the command, you should get an HTML response containing results from the backend you are testing.
   • If you do not get a response, delete the catch-all mapping rule from your product, promote the new APIcast configuration to staging and then to production, and run the example curl command.