Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(guides): Revisit Getting started #49

Merged
merged 5 commits into from Oct 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion assets/getting-started-how-superface-works.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 10 additions & 4 deletions docs/getting-started.mdx
Expand Up @@ -4,11 +4,19 @@ import HowItWorksDiagram from '../assets/getting-started-how-superface-works.svg

Superface is all about you, the consumer of API capabilities. To get started, first pick a capability and its provider, install it to your App and use Superface OneSDK to make the call.

:::info

This guide is more detailed version of the in-product [Getting started](https://superface.ai/getting-started) available at superface.ai.

You don't need an account at superface.ai to follow this guide.

:::

## How Superface works

Unlike every other API client, absolutely **no API information is hard-coded in your App or the SDK**.

The instructions how to make a call are downloaded during your App runtime and resolved by OneSDK to make a **direct HTTP** call to the API. The calls go straight from your App to the provider's API and are **never proxied through Superface**. This lets you change the instructions at runtime without updating or redeploying your App. You can even change providers while it’s running.
The instructions how to make a call are downloaded during your App runtime and resolved by OneSDK to make a **direct HTTP call** to the API. The calls go straight from your App to the provider's API and are **never proxied through Superface**. This lets you change the instructions at runtime without updating or redeploying your App. You can even change providers while it’s running.

<figure>
<HowItWorksDiagram />
Expand Down Expand Up @@ -81,9 +89,7 @@ npx @superfaceai/cli configure github --profile vcs/user-repos
In many cases you also need to set up provider credentials. Since we
are using the unauthenticated GitHub API we can skip it for now.

<!-- TODO:
To learn how to authenticate providers check the provider authentication.
-->
To learn how to handle API credentials, see [Setting provider API keys](guides/api-keys.md).

:::

Expand Down