New IA - Update the getting started pages

tyk-docs/content/getting-started/configure-first-api.md

@@ -0,0 +1,185 @@
+---
+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 **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`).
+   - **API Slug**: Define the path through which your API will be accessible (e.g., `/my-first-api/`).
+
+  {{< img src="/img/getting-started/apis-create-new-api.png" alt="Create New API" >}}
+
+<br>
+
+4. **Connect to Your Desired Gateway**
+  You may be prompted to choose between a Gateway and an Edge Gateway. 
+  - 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" >}}
+
+<br>
+
+5. **Configure Settings**
+
+  Configure your API settings:
+    - 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.png" alt="Configure Settings" >}}
+
+<br>
+
+6. **Authentication**: Choose the desired authentication method (e.g., **API Key**).
+
+    {{< img src="/img/getting-started/apis-add-authentication.png" alt="Add Authentication" >}}
+
+Save your API configuration once complete.
+
+
+## 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 **System Management** section.
+
+   {{< img src="/img/getting-started/apis-sidebar-security.png" alt="Keys Menu" >}}
+
+<br>
+
+2. **Click "Add Key"** to generate a new key.
+
+   {{< img src="/img/getting-started/apis-add-key.png" alt="Add Key" >}}
+
+<br>
+
+3. **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** or **Category** to filter APIs.
+   - Leave all other options at their default settings.
+
+4. **Add Configuration 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** 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.
+
+
+## Monitor Traffic and Analyze API Performance
+
+With your API live, monitor its traffic and analyze performance:
+
+### View Traffic Analytics
+
+1. **Navigate to the Analytics Section** in the dashboard.
+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 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.
+
+#### Example Log Entry
+
+```json
+{
+  "timestamp": "2024-09-05T12:00:00Z",
+  "method": "GET",
+  "path": "/my-api/users",
+  "status": 200,
+  "response_time": 95
+}
+```
+- **Timestamp**: The date and time when the API request was made (ISO 8601 format).
+
+- **Method**: The HTTP method used for the request (e.g., GET, POST).
+
+- **Path**: The API endpoint that was accessed.
+
+- **Status**: The HTTP status code returned by the API, indicating the result of the request (e.g., 200 for success).
+
+- **Response Time**: The time (in milliseconds) taken for the API to respond to the request.
+
+
+## Next Steps
+
+Congratulations! You've successfully created, secured, and deployed your first API in Tyk Cloud. Next, explore more advanced features like [rate-limiting](/getting-started/key-concepts/rate-limiting/) or [OAuth2](/basic-config-and-security/security/authentication--authorization).
+
+Explore more features in your dashboard to optimize and scale your API offerings.

tyk-docs/content/getting-started/create-account.md

@@ -0,0 +1,147 @@
+---
+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.
+
+### 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
+
+### Step 4: Choose Your Setup
+
+After completing the form, you can select which setup you'd like to kickoff your Tyk journey with.
+
+- If you're a new user, we suggest starting with the automatic setup. This will preconfigure your deployments, automatically setting up your control pane and gateways so you can familiarize yourself with what Tyk offers.
+
+- If you want to have more control, skip the automatic setup and personalize it yourself. You can tailor your setup to your organization's specific needs, manually setting up the teams, environments, control panes, and gateways. 
+
+{{< img src="/img/2.10/create-account-setup-choice.png" alt="Create Account Setup" >}}
+
+
+### Step 5: Verify Your Email
+
+Check your email inbox for a verification message from Tyk. Click the verification link to confirm your email address.
+
+### Step 6: Access the Developer Portal
+
+Once your account is set up, you can access the Tyk Developer Portal. The portal allows you to manage your APIs, view analytics, and customize your API consumer experience.
+
+Watch our video on configuring your Tyk Cloud Developer Portal.
+
+{{< youtube 8_SPUake84w >}}
+
+1. From the Control Plane Dashboard, select **Pages** from the **Portal Management** menu
+2. Click **Add 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/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/getting-started/portal_menu.png" alt="Portal Menu" >}}
+
+## Further Portal Configuration
+
+Our Developer Portal is completely customizable. See [Portal Customization]({{< ref "tyk-developer-portal/customise" >}}) for more details.
+
+
+## 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.
+
+## Accessing Your Tyk Cloud Dashboard
+
+After verifying your email, you can log in to your Tyk Cloud Dashboard. This is where you'll manage your APIs, analytics, and more.
+
+
+{{< 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:
+
+- **Explore the Dashboard**: Familiarize yourself with the [Tyk Cloud interface](/tyk-dashboard).
+- **Create Your First API**: Follow our guide on [setting up and securing your first API](/getting-started/configure-first-api).
+- **Customize Your Portal**: Learn how to customize the developer portal for your API consumers.
+- **Set Up Email Notifications**: Configure email notifications for important events and updates.
+
+## 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 [email protected].
+
+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!