improve API landing page

This commit is contained in:
Pascal Fischer
2023-05-05 19:39:42 +02:00
parent 05cbda8cd8
commit affd499f41
12 changed files with 59 additions and 42 deletions

View File

@@ -1,6 +1,9 @@
import {HeroPattern} from "@/components/HeroPattern";
export const description =
'In this guide, well look at how authentication works. Protocol offers two ways to authenticate your API requests: Basic authentication and OAuth2 with a token.'
<HeroPattern/>
# Authentication
You'll need to authenticate your requests to access any of the endpoints in the Protocol API. In this guide, we'll look at how authentication works. Protocol offers two ways to authenticate your API requests: Basic authentication and OAuth2 with a token — OAuth2 is the recommended way. {{ className: 'lead' }}

View File

@@ -9,7 +9,7 @@ export const description =
<HeroPattern />
# NetBird Documentation
# NetBird Docs
NetBird is a simple and fast alternative to corporate VPNs built on top of [WireGuard®](https://www.wireguard.com/) making it easy to create secure private networks for your organization or home.
It requires near zero configuration effort leaving behind the hassle of opening ports, complex firewall rules, vpn gateways, and so forth. {{ className: 'lead' }}

View File

@@ -1,3 +1,6 @@
import {HeroPattern} from "@/components/HeroPattern";
<HeroPattern/>
# Self-hosting Guide

View File

@@ -1,6 +1,9 @@
import {HeroPattern} from "@/components/HeroPattern";
export const description =
'In this guide, we will talk about what happens when something goes wrong while you work with the API.'
<HeroPattern/>
# Errors
In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and mostly they will be yours, not ours. Let's look at some status codes and error types you might encounter. {{ className: 'lead' }}

View File

@@ -12,7 +12,7 @@ export const sections = [
<HeroPattern />
# NetBird API
# NetBird REST API
Use the NetBird Public API to manage users, peers, network rules and more from inside your application or scripts to automate the setup of your mesh network. {{ className: 'lead' }}
@@ -23,14 +23,15 @@ Use the NetBird Public API to manage users, peers, network rules and more from i
## Getting started {{ anchor: false }}
To get started, create a new application in your [developer settings](#), then read about how to make requests for the resources you need to access using our HTTP APIs or dedicated client SDKs. When your integration is ready to go live, publish it to our [integrations directory](#) to reach the Protocol community. {{ className: 'lead' }}
To get started, it is recommended to create a [service user](#), that can later be used to communicate with the NetBird API.
To be able to send requests to our API you need [authenticate](#) on each request. This can be done either by Bearer token from you identity provider or by creating [personal access tokens](#) in the NetBird dashboard.{{ className: 'lead' }}
<div className="not-prose">
<Button
href="/sdks"
variant="text"
arrow="right"
children="Get your API key"
children="Get your personal access token"
/>
</div>

View File

@@ -1,6 +1,9 @@
import {HeroPattern} from "@/components/HeroPattern";
export const description =
'This guide will get you all set up and ready to use the Protocol API. Well cover how to get started an API client and how to make your first API request.'
<HeroPattern/>
# Quickstart
This guide will get you all set up and ready to use the Protocol API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API. {{ className: 'lead' }}