diff --git a/tyk-docs/assets/img/2.10/create-account-setup-choice.png b/tyk-docs/assets/img/2.10/create-account-setup-choice.png new file mode 100644 index 0000000000..16de34fb55 Binary files /dev/null and b/tyk-docs/assets/img/2.10/create-account-setup-choice.png differ diff --git a/tyk-docs/assets/img/2.10/portal-home-page-add.png b/tyk-docs/assets/img/2.10/portal-home-page-add.png deleted file mode 100644 index 9cd7eebe82..0000000000 Binary files a/tyk-docs/assets/img/2.10/portal-home-page-add.png and /dev/null differ diff --git a/tyk-docs/assets/img/2.10/portal-home-page-settings.png b/tyk-docs/assets/img/2.10/portal-home-page-settings.png deleted file mode 100644 index 54800e28cb..0000000000 Binary files a/tyk-docs/assets/img/2.10/portal-home-page-settings.png and /dev/null differ diff --git a/tyk-docs/assets/img/2.10/portal_menu.png b/tyk-docs/assets/img/2.10/portal_menu.png deleted file mode 100644 index c55a43f6ba..0000000000 Binary files a/tyk-docs/assets/img/2.10/portal_menu.png and /dev/null differ diff --git a/tyk-docs/assets/img/getting-started/api-activity-logs.png b/tyk-docs/assets/img/getting-started/api-activity-logs.png new file mode 100644 index 0000000000..d0982eaee1 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/api-activity-logs.png differ diff --git a/tyk-docs/assets/img/getting-started/api-management-apis.png b/tyk-docs/assets/img/getting-started/api-management-apis.png new file mode 100644 index 0000000000..5cd4e29a51 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/api-management-apis.png differ diff --git a/tyk-docs/assets/img/getting-started/api-url-provided-by-tyk.png b/tyk-docs/assets/img/getting-started/api-url-provided-by-tyk.png new file mode 100644 index 0000000000..18bb9ad0d9 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/api-url-provided-by-tyk.png differ diff --git a/tyk-docs/assets/img/getting-started/apis-add-authentication.png b/tyk-docs/assets/img/getting-started/apis-add-authentication.png new file mode 100644 index 0000000000..f4f4ae70e6 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/apis-add-authentication.png differ diff --git a/tyk-docs/assets/img/getting-started/apis-add-key.png b/tyk-docs/assets/img/getting-started/apis-add-key.png new file mode 100644 index 0000000000..ccb67191d5 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/apis-add-key.png differ diff --git a/tyk-docs/assets/img/getting-started/apis-analytics.png b/tyk-docs/assets/img/getting-started/apis-analytics.png new file mode 100644 index 0000000000..df15173210 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/apis-analytics.png differ diff --git a/tyk-docs/assets/img/getting-started/apis-configure-settings-1.png b/tyk-docs/assets/img/getting-started/apis-configure-settings-1.png new file mode 100644 index 0000000000..d98f17cb24 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/apis-configure-settings-1.png differ diff --git a/tyk-docs/assets/img/getting-started/apis-configure-settings-2.png b/tyk-docs/assets/img/getting-started/apis-configure-settings-2.png new file mode 100644 index 0000000000..f42632176e Binary files /dev/null and b/tyk-docs/assets/img/getting-started/apis-configure-settings-2.png differ diff --git a/tyk-docs/assets/img/getting-started/apis-connect-gateways.png b/tyk-docs/assets/img/getting-started/apis-connect-gateways.png new file mode 100644 index 0000000000..dc2db37e15 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/apis-connect-gateways.png differ diff --git a/tyk-docs/assets/img/getting-started/apis-create-key.png b/tyk-docs/assets/img/getting-started/apis-create-key.png new file mode 100644 index 0000000000..7e82de42ff Binary files /dev/null and b/tyk-docs/assets/img/getting-started/apis-create-key.png differ diff --git a/tyk-docs/assets/img/getting-started/apis-create-new-api.png b/tyk-docs/assets/img/getting-started/apis-create-new-api.png new file mode 100644 index 0000000000..e15b7a385c Binary files /dev/null and b/tyk-docs/assets/img/getting-started/apis-create-new-api.png differ diff --git a/tyk-docs/assets/img/getting-started/apis-front-page.png b/tyk-docs/assets/img/getting-started/apis-front-page.png new file mode 100644 index 0000000000..0b0d795430 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/apis-front-page.png differ diff --git a/tyk-docs/assets/img/getting-started/apis-keys-success.png b/tyk-docs/assets/img/getting-started/apis-keys-success.png new file mode 100644 index 0000000000..4b92e3e0fd Binary files /dev/null and b/tyk-docs/assets/img/getting-started/apis-keys-success.png differ diff --git a/tyk-docs/assets/img/getting-started/apis-sidebar-security.png b/tyk-docs/assets/img/getting-started/apis-sidebar-security.png new file mode 100644 index 0000000000..2c159ffeda Binary files /dev/null and b/tyk-docs/assets/img/getting-started/apis-sidebar-security.png differ diff --git a/tyk-docs/assets/img/getting-started/configure-api-key.png b/tyk-docs/assets/img/getting-started/configure-api-key.png new file mode 100644 index 0000000000..b7625d8d47 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/configure-api-key.png differ diff --git a/tyk-docs/assets/img/getting-started/create-account-add-api.png b/tyk-docs/assets/img/getting-started/create-account-add-api.png new file mode 100644 index 0000000000..6534253cee Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-account-add-api.png differ diff --git a/tyk-docs/assets/img/getting-started/create-account-deploy-tutorial.png b/tyk-docs/assets/img/getting-started/create-account-deploy-tutorial.png new file mode 100644 index 0000000000..7d4d2785c2 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-account-deploy-tutorial.png differ diff --git a/tyk-docs/assets/img/getting-started/create-account-design-from-scratch.png b/tyk-docs/assets/img/getting-started/create-account-design-from-scratch.png new file mode 100644 index 0000000000..2d7b6d9f5c Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-account-design-from-scratch.png differ diff --git a/tyk-docs/assets/img/getting-started/create-account-free-trial-info.png b/tyk-docs/assets/img/getting-started/create-account-free-trial-info.png new file mode 100644 index 0000000000..be4f70fbc7 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-account-free-trial-info.png differ diff --git a/tyk-docs/assets/img/getting-started/create-account-portal-pages.png b/tyk-docs/assets/img/getting-started/create-account-portal-pages.png new file mode 100644 index 0000000000..b2688af78e Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-account-portal-pages.png differ diff --git a/tyk-docs/assets/img/getting-started/create-account-resend-email.png b/tyk-docs/assets/img/getting-started/create-account-resend-email.png new file mode 100644 index 0000000000..281054b04a Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-account-resend-email.png differ diff --git a/tyk-docs/assets/img/getting-started/create-account-set-password.png b/tyk-docs/assets/img/getting-started/create-account-set-password.png new file mode 100644 index 0000000000..fce32e7dcd Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-account-set-password.png differ diff --git a/tyk-docs/assets/img/getting-started/create-account-start-trial.png b/tyk-docs/assets/img/getting-started/create-account-start-trial.png new file mode 100644 index 0000000000..8d53399238 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-account-start-trial.png differ diff --git a/tyk-docs/assets/img/getting-started/create-account-view-email.png b/tyk-docs/assets/img/getting-started/create-account-view-email.png new file mode 100644 index 0000000000..675ee3d1d0 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-account-view-email.png differ diff --git a/tyk-docs/assets/img/getting-started/create-api-security-key.png b/tyk-docs/assets/img/getting-started/create-api-security-key.png new file mode 100644 index 0000000000..3d1003520a Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-api-security-key.png differ diff --git a/tyk-docs/assets/img/getting-started/create-api-select-authentication.png b/tyk-docs/assets/img/getting-started/create-api-select-authentication.png new file mode 100644 index 0000000000..9b504b4990 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-api-select-authentication.png differ diff --git a/tyk-docs/assets/img/getting-started/create-api-server-section.png b/tyk-docs/assets/img/getting-started/create-api-server-section.png new file mode 100644 index 0000000000..8f5cf58478 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-api-server-section.png differ diff --git a/tyk-docs/assets/img/getting-started/create-new-api.png b/tyk-docs/assets/img/getting-started/create-new-api.png new file mode 100644 index 0000000000..66b6f771e8 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/create-new-api.png differ diff --git a/tyk-docs/assets/img/getting-started/overview-options.png b/tyk-docs/assets/img/getting-started/overview-options.png new file mode 100644 index 0000000000..3f5df6c82a Binary files /dev/null and b/tyk-docs/assets/img/getting-started/overview-options.png differ diff --git a/tyk-docs/assets/img/getting-started/portal-home-page-settings.png b/tyk-docs/assets/img/getting-started/portal-home-page-settings.png new file mode 100644 index 0000000000..bee47ca875 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/portal-home-page-settings.png differ diff --git a/tyk-docs/assets/img/getting-started/portal_menu.png b/tyk-docs/assets/img/getting-started/portal_menu.png new file mode 100644 index 0000000000..9f79455cbf Binary files /dev/null and b/tyk-docs/assets/img/getting-started/portal_menu.png differ diff --git a/tyk-docs/assets/img/getting-started/tabs-api-management.png b/tyk-docs/assets/img/getting-started/tabs-api-management.png new file mode 100644 index 0000000000..a3631d7196 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/tabs-api-management.png differ diff --git a/tyk-docs/assets/img/getting-started/tabs-api-security.png b/tyk-docs/assets/img/getting-started/tabs-api-security.png new file mode 100644 index 0000000000..947c2a77fd Binary files /dev/null and b/tyk-docs/assets/img/getting-started/tabs-api-security.png differ diff --git a/tyk-docs/assets/img/getting-started/tabs-classic-portal.png b/tyk-docs/assets/img/getting-started/tabs-classic-portal.png new file mode 100644 index 0000000000..8359ceba96 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/tabs-classic-portal.png differ diff --git a/tyk-docs/assets/img/getting-started/tabs-monitoring.png b/tyk-docs/assets/img/getting-started/tabs-monitoring.png new file mode 100644 index 0000000000..a76954cb1b Binary files /dev/null and b/tyk-docs/assets/img/getting-started/tabs-monitoring.png differ diff --git a/tyk-docs/assets/img/getting-started/tabs-system-management.png b/tyk-docs/assets/img/getting-started/tabs-system-management.png new file mode 100644 index 0000000000..0bb4570431 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/tabs-system-management.png differ diff --git a/tyk-docs/assets/img/getting-started/tabs-user-management.png b/tyk-docs/assets/img/getting-started/tabs-user-management.png new file mode 100644 index 0000000000..ac27b15794 Binary files /dev/null and b/tyk-docs/assets/img/getting-started/tabs-user-management.png differ diff --git a/tyk-docs/content/getting-started/configure-first-api.md b/tyk-docs/content/getting-started/configure-first-api.md new file mode 100644 index 0000000000..d4033cbe5f --- /dev/null +++ b/tyk-docs/content/getting-started/configure-first-api.md @@ -0,0 +1,177 @@ +--- +aliases: +- /quickstart-configure-first-api +date: 2020-06-24 +description: How to decide on which Tyk deployment option is best for you +linkTitle: Getting Started +tags: +- Tyk API Management +- Open Source +- Self-Managed +- Tyk Cloud +- API Gateway +title: Tyk QuickStart Configure Your First API +--- + + +## Overview +This guide helps you get started with Tyk Cloud by covering the basics: + +- **Set up your API**: Create and configure a new API in the Tyk Dashboard. +- **Create API keys**: Generate API keys and assign them to your APIs for secure access. +- **Monitor API performance**: Track traffic, logs, and performance analytics. + +Follow these steps to quickly create and manage your APIs in Tyk Cloud. + +## Prerequisites + +Before you begin, make sure you have: +- [A Tyk Cloud account](/getting-started/create-account). +- Admin access to the Tyk Dashboard. +- (optional) A backend service that your API will proxy (e.g., a RESTful API) - or you can use the httpbin service. + + +## Set Up Your API + +Start by creating a new API in Tyk Cloud: + +1. **Log in to the Tyk Dashboard**. +2. **Navigate to APIs** and click **Add New API** or **Design From Scratch** button. + + {{< img src="/img/getting-started/create-account-design-from-scratch.png" alt="Create New API" >}} + +3. **Configure API Details**: + - **API Name**: Name your API (e.g., `My First API`). + - **API Type**: Choose from HTTP, TCP, GraphQL, UDG, or Federation, depending on your use case. + - **API Style**: Select OpenAPI for standardized HTTP APIs or Classic for flexible configurations and non-HTTP APIs. + - **Target URL**: Provide the URL of your backend service (e.g., `http://httpbin.org`). + + {{< img src="/img/getting-started/create-new-api.png" alt="Create New API" >}} + +4. **Connect to Your Desired Gateway**: + + You will be prompted to choose between a Gateway and an Edge Gateway, which are already created for you. + - `Edge Gateways` generally provide low-latency, regionally distributed API processing, ideal for a global user base. + - `Regular Gateways` centralize API management, offering comprehensive API processing without additional edge optimizations. + + {{< img src="/img/getting-started/apis-connect-gateways.png" alt="Connect Gateways" >}} + +5. **Configure your API Settings**: + + - **Expiration Date**: An optional config that allows you to set an expiry date for this API, where access will expire after this date. This can be edited at any time. + - **Gateway Status**: Setting this to `Active` will publish your API and make it public. When in the `Disabled` state, your API will stay in a draft state until you are ready to publish it. This is a required field, for this guide we will set it to `Active`. + - **Access**: Your API can be set to either `Internal` or `External`, determining whether you want to keep your API accessible only through Tyk or to external services, respectively. This is a required field, for this guide we will set it to `External`. + +{{< img src="/img/getting-started/apis-configure-settings-1.png" alt="Configure Settings" >}} + +Scrolling down, In the **Upstream** section you can configure settings to control the behaviour of your upstream APIs. +{{< note success >}} + **Note** + + These are not necessary to add now but they are good to explore. + {{< /note >}} + + - **API Rate Limiting**: Set limits on the number of requests (e.g., 100 requests per minute) to control usage and prevent abuse. + - **Service Discovery**: Enable dynamic backend discovery with tools like Consul or Kubernetes, ensuring traffic is directed to healthy instances. + - **Upstream Client Certificates**: Use client certificates for secure backend connections via mutual TLS (mTLS), adding an extra layer of security. + - **Certificate Public Key Pinning**: Pin specific public keys to validate certificate authenticity and prevent unauthorized access. + + {{< img src="/img/getting-started/apis-configure-settings-2.png" alt="Configure Settings cont" >}} + +6. **Configuring the Server section**: + + In the section you can configure Tyk Gateway related settings. Below are some important configurations. + - **Listen Path**: This is the `path` Tyk API will use to proxy your API requests. So a request made to this URL `https:///` will be proxied to the upstream URL configured above. + - **Authentication**: Choose the desired authentication method (e.g., **API Key**). + + {{< img src="/img/getting-started/create-api-select-authentication.png" alt="Add Authentication" >}} + +Save your API configuration once complete. + +7. **Copy the API URL** + - When you save the API configuration, Tyk generates a unique Gateway URL that can be used to access your API. Copy this URL, we will use it later during testing. + + {{< img src="/img/getting-started/api-url-provided-by-tyk.png" alt="Tyk API Gateway URL" >}} + +## Create an API Key + +The Tyk Dashboard provides the simplest way to generate a new API key. Follow these steps: + +1. **Select "Keys"** from the **API Security** section and **Click "Add Key"** to generate a new key. + + {{< img src="/img/getting-started/create-api-security-key.png" alt="Create API Key" >}} + +2. **Add a Policy or API to Your Key**: + - You can either add your key to an existing **Policy** or assign it to an individual **API**. + - For this guide, we will assign the key to the `My First API` which we created in the previous step. You can: + - Scroll through your **API Name list**, + - Use the **Search field** or **Group by Authentication Type** to filter APIs. + - Leave all other options at their default settings. + + {{< img src="/img/getting-started/configure-api-key.png" alt="Configure API Key" >}} + +4. Click on the **Configuration Tab** and add the below details. + - **Enable Detailed Logging**: This is optional and disabled by default. + - **Key Alias**: Assign an alias to your key for easier identification. + - **Key Expiry**: Set an expiry time from the drop-down list. This is required. + - **Tags**: Add tags for filtering data in Analytics. Tags are case-sensitive. + - **Metadata**: Add metadata such as user IDs, which can be used by middleware components. + +5. Click **CREATE**: + - Once the key is created, a **Key successfully generated** pop-up will be displayed showing your key. **Copy the key ID** to your clipboard and save it for future reference as it will not be shown again. And that should result in a successfully generated key! + + {{< img src="/img/getting-started/apis-keys-success.png" alt="Key Success" >}} + + + {{< note success >}} + **Note** + + When creating a key in Tyk, you should copy the key ID. This is the identifier you’ll need for referencing the key in your API requests or configurations. The hash is generally used internally by Tyk and is not required for most user-facing tasks. + + {{< /note >}} + + +## Test Your API + +After configuring and deploying your API, it’s essential to test it to ensure it performs as expected. Follow these steps to verify your API setup: + +1. **Retrieve Your API Key**: + - Copy the **API Key ID** from the previous step as you'll need it to authenticate requests to your API. + +2. **Make a Test Request**: + - Use a tool like [Postman](https://www.postman.com/) or `curl` to send a request to your API endpoint. + - Example request using `curl`: + ```bash + curl -H "Authorization: {YOUR_API_KEY_ID}" https://{YOUR_TYK_GATEWAY_URL}/my-first-api/ + ``` + - Replace `{YOUR_API_KEY_ID}` with the actual key ID and `{YOUR_TYK_GATEWAY_URL}` with your gateway's URL. + - Send the request and you should get HTML output with `200` status code. + + +## Monitor Traffic and Analyze API Performance + +With your API live, monitor its traffic and analyze performance: + +### View Traffic Analytics + +1. **Navigate to the Monitoring Section** in the dashboard. And click on **Activity Overview**. +2. **View Traffic Metrics**: Review metrics such as request count, response times, and error rates. +3. **Analyze Data**: Use traffic trends to identify performance issues or optimize API behavior. + +{{< img src="/img/getting-started/apis-analytics.png" alt="APIs Analytics" >}} + + +### View Log Data + +1. **Go to the Activity Logs Section** of your API. +2. **Search and Filter Logs**: Use filters to drill down by response status, endpoint, or client IP. +3. **Review Detailed Logs**: View full request and response data to troubleshoot issues. + +{{< img src="/img/getting-started/api-activity-logs.png" alt="APIs Logs" >}} + + +## Next Steps + +Congratulations! You've successfully created, secured, and deployed your first API in Tyk Cloud. Next, explore more advanced features like [rate-limiting]({{< ref "getting-started/key-concepts/rate-limiting" >}}) or [OAuth2]({{< ref "basic-config-and-security/security/authentication-authorization/oauth-2-0" >}}). + +Explore more features in your [dashboard]({{< ref "getting-started/using-tyk-dashboard" >}}) to optimize and scale your API offerings. \ No newline at end of file diff --git a/tyk-docs/content/getting-started/create-account.md b/tyk-docs/content/getting-started/create-account.md new file mode 100644 index 0000000000..18b45ee5b8 --- /dev/null +++ b/tyk-docs/content/getting-started/create-account.md @@ -0,0 +1,138 @@ +--- +aliases: +- /create-account +date: 2020-06-24 +description: How to decide on which Tyk deployment option is best for you +linkTitle: Getting Started +tags: +- Tyk API Management +- Open Source +- Self-Managed +- Tyk Cloud +- API Gateway +title: Create Tyk Account +aliases: + - /tyk-cloud/initial-portal-config +--- + + +Welcome to Tyk! This guide will walk you through the process of creating your account and getting started with our powerful API management platform. + +## Choosing Your Tyk Solution + +Tyk offers multiple deployment options to suit your needs: + +- **Tyk Cloud**: A fully managed service for easy API management at any scale. +- **Tyk Self-Managed**: Install the full lifecycle API management solution in your own infrastructure. +- **Tyk Open Source**: The core API Gateway, freely available and open source. + +For this guide, we'll focus on creating an account for Tyk Cloud, which offers a free 48 hour trial. + +## Creating Your Tyk Cloud Account + +### Step 1: Visit the Sign-Up Page + +Navigate to the Tyk sign-up page at [https://tyk.io/sign-up/](https://tyk.io/sign-up/). + +### Step 2: Choose "Start Your 48-hour Free Trial" + +On the sign-up page, select the "Start your 48-hour free trial" option to begin your Tyk Cloud experience. + +{{< img src="/img/getting-started/create-account-start-trial.png" alt="Start Trial" >}} + + +### Step 3: Complete the Account Creation Form + +Fill out the account creation form with your details: + +- First Name +- Last Name +- Email Address +- Password +- Company Name (if applicable) +- Work Role and How We Can Help + + +{{< img src="/img/getting-started/create-account-free-trial-info.png" alt="Create Account Free Trial" >}} + + +### Step 4: Check Your Email +Check your email inbox for a verification message from Tyk. Click the verification link to confirm your email address. + +{{< img src="/img/getting-started/create-account-resend-email.png" alt="Create Account Resend Email" >}} + + +In your inbox, you should find this email (press "Log in"): + +{{< img src="/img/getting-started/create-account-view-email.png" alt="Create Account View Email" >}} + + + +### Step 5: Create Password +After finding the email and logging in, set your password, organization name (any name which you want to represent your environment), and control plane region (select the control plane which is closest to your location). + +{{< img src="/img/getting-started/create-account-set-password.png" alt="Create Account Set Password" >}} + + + +### Step 6: Deploy and Take Tutorial +Once your password, organization, and control plane are setup, continue to the next page where your environment will be deployed. This may take 2-5 minutes, you can peruse the tutorial to learn how to use the dashboard while you wait. + +{{< img src="/img/getting-started/create-account-deploy-tutorial.png" alt="Create Account Deploy Tutorial" >}} + + +After a few minutes, the "Add API" button should appear. Select it and you will be taken to the dashboard. + +{{< img src="/img/getting-started/create-account-add-api.png" alt="Create Account Add API" >}} + + +### Step 7: Start Creating APIs +Finally, you will be taken to the Tyk Dashboard. Select "Design From Scratch" and continue on to [our tutorial](/getting-started/configure-first-api) to learn how to setup and secure your APIs. + +{{< img src="/img/getting-started/create-account-design-from-scratch.png" alt="Create Account Design From Scratch" >}} + +## What Happens Next? + +Once you've created your account, Tyk will automatically: + +- **Assigns Billing Admin Role**: You are designated as the Billing Admin for your organization, granting you full access to manage billing details and subscription plans. + +- **Activates 48-Hour Free Trial**: Your account is enrolled in a 48-hour free trial of Tyk Cloud, allowing you to explore its features and capabilities without immediate commitment. + +- **Creates Initial Organization**: An organization is automatically established, serving as the primary entity for managing your environments, APIs, and users. + +- **Establishes Default Team**: A default team is set up within your organization, providing a collaborative space for managing APIs and related resources. + +- **Deploys Control Plane**: A control plane is deployed in your selected home region, centralizing the management of your APIs, policies, and configurations. + +- **Deploys Gateway**: A Tyk Gateway is deployed to manage and route incoming API traffic, handling authentication, rate limiting, and analytics to ensure secure, reliable access. + +For certain Tyk Cloud configurations, you may also get an Edge Gateway deployment option, allowing gateways to be positioned closer to users for lower latency and optimized routing. This is ideal for multi-region or global API setups but may require additional configuration or regional deployment options through Tyk’s Multi Data Centre Bridge (MDCB) if set up manually. + + + +{{< note success >}} +**Note** + +After the 48-hour free trial of Tyk Cloud ends, your infrastructure (control plane, gateway, and organization settings) will be deactivated unless you upgrade to a paid plan. Here’s what happens: + +- Limited Access: Control plane access and API traffic routing through the gateway will be suspended. +- Data Retention: Your configurations (APIs, policies, user settings) are temporarily retained, allowing you to pick up where you left off if you upgrade within a grace period. +- Billing Admin Role: You’ll still be able to manage billing and subscription options. + +Upgrading restores full functionality, letting you continue from where you paused. To avoid disruption, consider exploring paid plans before your trial ends. + +{{< /note >}} + +## Next Steps + +Now that you have your Tyk account set up, here are some recommended next steps: + +- **Create Your First API**: Follow our guide on [setting up and securing your first API]({{< ref "getting-started/configure-first-api" >}}). +- **Explore the Dashboard**: Familiarize yourself with the [Tyk Cloud interface]({{< ref "tyk-dashboard" >}}). + +## Need Help? + +If you encounter any issues or have questions during the setup process, don't hesitate to reach out to our support team at support@tyk.io. + +Remember, Tyk offers powerful features for API management, security, and performance. Take advantage of your trial period to explore all that Tyk has to offer! \ No newline at end of file diff --git a/tyk-docs/content/getting-started/using-tyk-dashboard.md b/tyk-docs/content/getting-started/using-tyk-dashboard.md new file mode 100644 index 0000000000..db120c9ce0 --- /dev/null +++ b/tyk-docs/content/getting-started/using-tyk-dashboard.md @@ -0,0 +1,105 @@ +--- +aliases: +- /using-tyk-dashboard +date: 2020-06-24 +description: How to decide on which Tyk deployment option is best for you +linkTitle: Getting Started +tags: +- Tyk API Management +- Open Source +- Self-Managed +- Tyk Cloud +- API Gateway +title: Using Tyk Dashboard +--- + +The Tyk Dashboard is your central hub for managing APIs, monitoring performance, and configuring security settings. This guide will walk you through the key features available on the Tyk Dashboard. + +## Access the Dashboard + +Log in to your **Tyk Dashboard** using your credentials. Familiarize yourself with the interface, where the main navigation menu is located on the left side, and the top bar provides quick access to user settings and notifications. + +## Dashboard Organization +{{< img src="/img/getting-started/apis-front-page.png" alt="Front Page" >}} + + +Welcome to the Tyk Dashboard! Let's zoom into the side bar and take a look at the features that are made available to you. + +### Side Bar +Tyk is organized into a few key categories: +* **API Management**: In API Management, you can access and edit all your APIs, create data graphs, and add webhooks. +* **API Security**: In API Security, you can manage keys, policies, and certificates to customize your security settings. +* **User Management**: In User Management, you can control permissions and access for users and user groups. You can also create profiles that help you manage third party identity providers for specific Tyk actions like signing into the portal or logging into the dashboard. +* **Monitoring**: In Monitoring, you can view activity reports, logs, and analytics related to your APIs. +* **System Management**: In System Management, you can affect OPA rules that define fine-grained access control for managing and enforcing permissions on various actions and resources in Tyk’s API management system. +* **Classic Portal**: In Classic Portal, you can affect permissions and configurations related to your developer portal. The Tyk Developer Portal is a platform that enables you to publish, manage, and promote your APIs to external developers. + + +#### Overview +{{< img src="/img/getting-started/overview-options.png" alt="Overview options" >}} + +From the overview options, you can start adding APIs immediately. +If you are new here, we suggest that you start with an example API and see how our pre-configured APIs are setup- we have examples for GraphQL, Tyk OAS, and UDG (Universal Data Graph) APIs. If you have a specific API that you that you have already setup, you can import it using an OpenAPI document, a Tyk API document, or through a WSDL/XML file. +Otherwise, you can design an API from scratch or a template if you have configured a Tyk template previously. + + + +#### API Management +{{< img src="/img/getting-started/tabs-api-management.png" alt="API Management Side Bar" >}} + +* **APIs**: The APIs setup allows you to create and access your APIs. If this is your first time setting up an API, we suggest you use an example to learn more or you can go to [Configure your First API](/getting-started/configure-first-api) to learn more. +{{< img src="/img/getting-started/api-management-apis.png" alt="API Management APIs" >}} + +* **API Templates**: API Templates allow you to create APIs with preconfigured settings quickly. You can set these up manually or save them from an API which you've already created. You can learn more about API Templates [here](/product-stack/tyk-dashboard/advanced-configurations/templates/template-overview/). + +* **Examples**: In Examples, you will find a few sample projects we put together to help you in your journey. We suggest you start with the Tyk OAS APIs and move on to GraphQL and UDG APIs to supplement learning how to setup your API. + +* **Data Graphs**: Universal Data Graphs (UDGs) are a way for you to combine APIs into one usable interface. Using GraphQL, you can access multiple APIs in a single query. In this tab, you can configure your UDGs. You can learn more about Data Graph concepts and how to use them in Tyk, [here](/universal-data-graph/). + +* **Webhooks**: Webhooks allow you to define redirects to handle specific events. For instance, you can configure a webhook to handle a RateLimitExceeded event to send a notification to your admin. Webhooks are very powerful tools to allow you to customize event handling, to learn more, find more information [here](/basic-config-and-security/report-monitor-trigger-events/webhooks). + +#### API Security +{{< img src="/img/getting-started/tabs-api-security.png" alt="API Security Side Bar" >}} + +* **Keys**: [Keys](/basic-config-and-security/security/key-level-security) are central to securing your APIs through Tyk. In this tab, you can handle the permissions, rate and throttling limits, and quotas associated with a given key. +* **Policies**: [Policies](/basic-config-and-security/security/security-policies) expand on key level security, allowing you to configure granular control over API access. Using policies, you govern which users or applications can access particular endpoints and what they're allowed to do. +* **TLS/SSL Certificates**: [TLS and SSL](/basic-config-and-security/security/tls-and-ssl) is supported in Tyk. You can upload your certificates via `.pem` file to verify the identity of whoever presents the certificate during a secure connection. + + +#### User Management +{{< img src="/img/getting-started/tabs-user-management.png" alt="User Management Side Bar" >}} + +* **Users**: Here, you can add, revoke, delete, or edit the details of users that need admin access to your Tyk dashboard. 'Revoking' a user will suspend their access without deleting their account. You can learn more about users [here](/tyk-dashboard-api/users). +* **User Groups**: Similar as a **policy** is to a **key**, a **user group** is to a **user**. By defining user groups, you aggregate the permissions and access controls for multiple users. When you setup a user with a user group, they inherit the user groups' permissions. You can learn more about user groups [here](/tyk-apis/tyk-dashboard-api/user-groups). +* **User Settings**: In User Settings, you can setup [TIB profiles](/tyk-stack/tyk-identity-broker/about-profiles/). This allows your users to access Tyk-managed APIs using their existing credentials. + +#### Monitoring +{{< img src="/img/getting-started/tabs-monitoring.png" alt="Monitoring Side Bar" >}} + +* **Activity Overview**: In the Activity Overview Tab, you will get a high-level view of requests sent to your APIs, the error breakdown, and your most popular endpoints. You can filter this to view per API statistics and to see the breakdown per hour, day, or month. +* **Activity logs**: Here, you can view all the activity logs from your APIs, giving you details on user activity or error logs. +* **Activity by X**: There are several tabs that allow you to view your activity reports per API, Key, Endpoint, Graph, and Errors. We provide these tools for you so that you can quickly visit the analytics you're interested in and gain insights on your APIs. +* **Service Uptime**: Here, you can view the service uptime statistics, getting a detailed view of your uptime per version of your API. You can also view the errors associated with your API and if you are hitting your uptime targets. +* **Uptime Targets**: You can view uptime by target endpoint here, this is particularly useful if you have configured [uptime tests](/planning-for-production/ensure-high-availability/uptime-tests/) to gain visibility into the uptime of your underlying services. + + + +#### System Management +{{< img src="/img/getting-started/tabs-system-management.png" alt="System Management Side Bar" >}} + +* **OPA Rules**: You can use this tab to edit your [OPA Rules](/tyk-dashboard/open-policy-agent/)- you can use these custom rules to control the behavior of all of your dashboard APIs. For example, you can restrict regular users to GET requests only, while allowing POST requests for admin roles. + + +#### Classic Portal +{{< img src="/img/getting-started/tabs-classic-portal.png" alt="Classic Portal Side Bar" >}} + +* **Open Portal**: By clicking this, you will be redirected to the Developer Portal, where developers can access your APIs. This acts as a self-service gateway where developers can discover, request access to, and manage their API Keys, view documentation, and monitor usage reports. You can learn more about the developer portal and how to customize it [here](/tyk-developer-portal/customise/). + +* **Settings**: Tyk allows you to customize your portal however you like. The first level of customization occurs through configuring your settings. Here, you can setup your portal domain name, establish an admin to be notified whenever you get an API subscription, affect access and permissions to your portal, and enable email notifications to be sent to the developers using your portal. You can learn more about customizing your settings [here](/tyk-developer-portal/customise/customize-api-visibility/). +* **Catalogue**: Your catalogue is the full list of APIs made available in your portal. You can add APIs to your catalogue in this tab. You can learn more about how to affect your catalogues [here](/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-catalogues/). +* **Key Requests**: For the APIs listed in your catalogue, you developers will submit key requests to gain access to them. This page allows you to view the full list of key requests, you can use it to see what APIs are gaining popularity, you can also approve or decline key requests here. You can learn more about key requests [here](/tyk-developer-portal/tyk-portal-classic/key-requests/). +* **Developers**: Developers are the people consuming your APIs. You can [add developers](/tyk-developer-portal/tyk-portal-classic/developer-profiles/) to your portal in this tab. +* **Pages**: As mentioned earlier, your portal is completely customizable. This tab makes it easy to add or edit the pages available in your portal. You can make this as simple or complicated as you want, you just have to add a title and URL for each page. You can learn more about adding pages to your portal [here](/tyk-stack/tyk-developer-portal/enterprise-developer-portal/customise-enterprise-portal/full-customisation/edit-manage-page-content/). +* **Menus**: Next, if you want to configure the navigation of your site, you can [customize your menus](/tyk-developer-portal/tyk-portal-classic/customise/changing-the-navigation/). +* **CSS**: In this tab, you can customize your site using CSS. Just write a custom CSS script and press the "update" button in the top right corner to publish your custom styling. For inspiration, take a look at this [tutorial](/tyk-developer-portal/tyk-portal-classic/customise/customising-using-dashboard/). + diff --git a/tyk-docs/content/shared/create-portal-entry-include.md b/tyk-docs/content/shared/create-portal-entry-include.md index 3b9b202982..8884e7509e 100644 --- a/tyk-docs/content/shared/create-portal-entry-include.md +++ b/tyk-docs/content/shared/create-portal-entry-include.md @@ -97,4 +97,4 @@ To save the API, click **SAVE**. You can now visit your portal to see the API catalog entry. Select **Open Your Portal** from the **Your Developer Portal** menu: -{{< img src="/img/2.10/portal_menu.png" alt="Portal nav menu location" >}} +{{< img src="/img/getting-started/portal_menu.png" alt="Portal nav menu location" >}} diff --git a/tyk-docs/content/tyk-cloud/initial-portal-config.md b/tyk-docs/content/tyk-cloud/initial-portal-config.md index 355f4c6a95..da3553e7bd 100644 --- a/tyk-docs/content/tyk-cloud/initial-portal-config.md +++ b/tyk-docs/content/tyk-cloud/initial-portal-config.md @@ -20,20 +20,20 @@ Watch our video on configuring your Tyk Cloud Developer Portal. 1. From the Control Plane Dashboard, select **Pages** from the **Portal Management** menu 2. Click **Add Page** -{{< img src="/img/2.10/portal-home-page-add.png" alt="Add Portal Page" >}} +{{< img src="/img/getting-started/create-account-portal-pages.png" alt="Add Portal Page" >}} 3. In the Settings, give your page a name and slug. Below we've called it Home 4. Select **Check to make this page the Home page** 5. Select **Default Home page template** from the Page type drop-down list 6. You can leave the Registered Fields sections for now -{{< img src="/img/2.10/portal-home-page-settings.png" alt="Portal Home page settings" >}} +{{< img src="/img/getting-started/create-account-portal-pages.png" alt="Portal Home page settings" >}} 7. Click **Save**. You should now be able to access your Portal from **Open Your Portal** from the **Your Developer Portal** menu. -{{< img src="/img/2.10/portal_menu.png" alt="Portal Menu" >}} +{{< img src="/img/getting-started/portal_menu.png" alt="Portal Menu" >}} ## Further Portal Configuration diff --git a/tyk-docs/data/menu.yaml b/tyk-docs/data/menu.yaml index 691011ccbe..066fcd6980 100644 --- a/tyk-docs/data/menu.yaml +++ b/tyk-docs/data/menu.yaml @@ -5,6 +5,23 @@ menu: path: / category: Label show: True + - title: "Getting Started" + path: / + category: Label + show: True + menu: + - title: "Create Account" + path: /getting-started/create-account + category: Page + show: True + - title: "Configure Your First API" + path: /getting-started/configure-first-api + category: Page + show: True + - title: "Using Tyk Dashboard" + path: /getting-started/using-tyk-dashboard + category: Page + show: True - title: "Deployment and Operations" path: /apim category: Label