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

docs: Finished the API apps page based on discussion with Benjamin #170

Merged
merged 5 commits into from
Mar 12, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions packages/docs/docs/guides/3-API/3-api-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,24 @@ title: API Apps
keywords: [Request, Apps, API]

---
import useBaseUrl from '@docusaurus/useBaseUrl';

# Introduction
## Introduction

Developers can build on top of Request API by creating Applications.

With an application, you will be able to read, create, and perform actions on requests, on behalf of your users.
With an application, you will be able to read, create, and perform actions on requests, **on behalf of your users**.

# How it works
## How it works

An application built on top of Request API needs to authenticate with the OAuth2 mechanism.
We recommend using [Auth0 SDKs](https://auth0.com/docs/libraries#sdks) to integrate it, but you are free to choose whatever you want.

# Getting started
## Getting started

TODO: unlock the Apps feature for all users??
Unlock this option by getting in touch with us on the [Request Hub](https://join.slack.com/t/requesthub/shared_invite/enQtMjkwNDQwMzUwMjI3LTc5NDRmN2YyMTVhZTBjNDE2MWU2YTBlYWIzYmJlYzNkMWQ5MzVmYzEzNGVmYjliNDQ4MjkyNTBiYjk4MDk3ZGE).

<img alt="Authenticate your app into the Request Portal" src={useBaseUrl('img/portal-api-app.gif')} />

- First, make sure you have [signed up](https://dashboard.request.network/signup) to Request
- Fork our [demo codesandbox](https://codesandbox.io/s/request-api-apps-zqt8o)
Expand All @@ -36,5 +39,6 @@ As an app developer, you will _not_ see your users' requests in your dashboard.
:::


# Get help
TODO: Get in touch with us
## Get help

Do you have questions ? Or do you have troubles authenticating your app? Get in touch with us on the [Request Hub](https://join.slack.com/t/requesthub/shared_invite/enQtMjkwNDQwMzUwMjI3LTc5NDRmN2YyMTVhZTBjNDE2MWU2YTBlYWIzYmJlYzNkMWQ5MzVmYzEzNGVmYjliNDQ4MjkyNTBiYjk4MDk3ZGE).
Binary file added packages/docs/static/img/portal-api-app.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.