Skip to content
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 0 additions & 114 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,120 +14,6 @@ items:
- url: /extend/
title: Extending Keboola
items:
- url: /extend/generic-extractor/
title: Generic Extractor
items:
- url: /extend/generic-extractor/tutorial/
title: Generic Extractor Tutorial
items:
- url: /extend/generic-extractor/tutorial/rest/
title: REST HTTP API Introduction

- url: /extend/generic-extractor/tutorial/json/
title: JSON Introduction

- url: /extend/generic-extractor/tutorial/basic/
title: Basic Configuration

- url: /extend/generic-extractor/tutorial/pagination/
title: Pagination Tutorial

- url: /extend/generic-extractor/tutorial/jobs/
title: Jobs Tutorial

- url: /extend/generic-extractor/tutorial/mapping/
title: Mapping Tutorial

- url: /extend/generic-extractor/configuration/
title: Configuration
items:
- url: /extend/generic-extractor/configuration/api/
title: API Configuration
items:
- url: /extend/generic-extractor/configuration/api/pagination/
title: Pagination
items:
- url: /extend/generic-extractor/configuration/api/pagination/response-url/
title: Response URL Scroller

- url: /extend/generic-extractor/configuration/api/pagination/response-param/
title: Response Parameter Scroller

- url: /extend/generic-extractor/configuration/api/pagination/offset/
title: Offset Scroller

- url: /extend/generic-extractor/configuration/api/pagination/pagenum/
title: Page Number Scroller

- url: /extend/generic-extractor/configuration/api/pagination/cursor/
title: Cursor Scroller

- url: /extend/generic-extractor/configuration/api/pagination/multiple/
title: Multiple Scrollers

- url: /extend/generic-extractor/configuration/api/authentication/
title: Authentication
items:
- url: /extend/generic-extractor/configuration/api/authentication/query/
title: Query

- url: /extend/generic-extractor/configuration/api/authentication/basic/
title: Basic

- url: /extend/generic-extractor/configuration/api/authentication/bearer_token/
title: Bearer Token

- url: /extend/generic-extractor/configuration/api/authentication/api_key/
title: API Key

- url: /extend/generic-extractor/configuration/api/authentication/login/
title: Login

- url: /extend/generic-extractor/configuration/api/authentication/oauth_cc/
title: OAuth 2.0 Client Credentials

- url: /extend/generic-extractor/configuration/api/authentication/oauth10/
title: OAuth 1.0

- url: /extend/generic-extractor/configuration/api/authentication/oauth20/
title: OAuth 2.0

- url: /extend/generic-extractor/configuration/api/authentication/oauth20-login/
title: Login using OAuth 2.0

- url: /extend/generic-extractor/configuration/config/
title: Extraction Configuration
items:
- url: /extend/generic-extractor/configuration/config/jobs/
title: Jobs
items:
- url: /extend/generic-extractor/configuration/config/jobs/children/
title: Child Jobs

- url: /extend/generic-extractor/configuration/config/mappings/
title: Mappings

- url: /extend/generic-extractor/configuration/iterations/
title: Iterations

- url: /extend/generic-extractor/configuration/ssh-proxy/
title: SSH Proxy Configuration

- url: /extend/generic-extractor/map/
title: Configuration Map

- url: /extend/generic-extractor/functions/
title: Functions

- url: /extend/generic-extractor/incremental/
title: Incremental Extraction

- url: /extend/generic-extractor/running/
title: Running Generic Extractor

- url: /extend/generic-extractor/publish/
title: Publishing Component

- url: /extend/generic-writer/
title: Generic Writer
items:
Expand Down
2 changes: 1 addition & 1 deletion cli/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Created new config "main/extractor/ex-generic-v2/wiki"
```

Edit file `main/extractor/ex-generic-v2/wiki/config.json` as
a [Generic Extractor](/extend/generic-extractor/) configuration. A super basic
a [Generic Extractor](https://help.keboola.com/components/extractors/generic-extractor/) configuration. A super basic
configuration could look like this:

```json
Expand Down
Binary file removed extend/generic-extractor/configuration.png
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,74 +1,5 @@
---
title: API Key Authentication
permalink: /extend/generic-extractor/configuration/api/authentication/api_key/
redirect_to: https://help.keboola.com/components/extractors/generic-extractor/configuration/api/authentication/api_key/
---

API Key token authentication sends a token in either a header or query parameter of each API request.

E.g., Headers: `X-StorageApi-Token:your_token`

This method is available through UI. You can select the `Api Key Auth` method and fill in the token.

{: .image-popup}
![Api Key](/extend/generic-extractor/configuration/api/authentication/api_key.png)

### Configuration parameters

- `Key` - arbitrary name of the header or query parameter key, e.g., `X-StorageApi-Token`
- `Token` - the actual token value
- `Add to` - where to add the token, either to the headers or query parameters


### JSON

In the underlying JSON, the API Key is implemented as follows:

Place your token into the `config.#__AUTH_TOKEN` parameter. The `Authorization` header is then constructed using the `concat` function.

**Header section**

{% highlight json %}
{
"api": {
...,
"http": {
"http": {
"headers": {
"X-StorageApi-Token": {
"attr": "#__AUTH_TOKEN"
}
}
}
}
},
"config": {
"#__AUTH_TOKEN": "secret",
"jobs": [...]
}
}
{% endhighlight %}


**Query section**

{% highlight json %}
{
"api": {
...,
"http": {
"http": {
"params": {
"X-StorageApi-Token": {
"attr": "#__AUTH_TOKEN"
}
}
}
}
},
"config": {
"#__AUTH_TOKEN": "secret",
"jobs": [...]
}
}
{% endhighlight %}

Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,80 +1,5 @@
---
title: Basic Authentication
permalink: /extend/generic-extractor/configuration/api/authentication/basic/
redirect_to: https://help.keboola.com/components/extractors/generic-extractor/configuration/api/authentication/basic/
---

Basic Authentication provides the [HTTP Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)
method. It requires entering a username and password in the configuration and sends the encoded values in the
`Authorization` header.

### User Interface

In the user interface, you simply select the `Basic Authorization` method and enter the username and password.

### JSON

A sample Basic authentication looks like this:

{: .image-popup}
![Basic](/extend/generic-extractor/configuration/api/authentication/basic.png)

{% highlight json %}
{
"api": {
...,
"authentication": {
"type": "basic"
}
},
"config": {
"#username": "JohnDoe",
"#password": "secret"
}
}
{% endhighlight %}

The `username` and `password` fields are part of the [`config` section](/extend/generic-extractor/configuration/config/).
They are also prefixed by the hash `#` character, which means they are stored [encrypted](/overview/encryption/).
If the API expects something else than a username and password in the `Authorization` header, or if it requires
a custom authorization header, use the [Default Headers option](/extend/generic-extractor/configuration/api/#headers).

## Configuration Parameters
This `basic` type of authentication has no configuration parameters. The login and password must be provided in the
[`config` section](/extend/generic-extractor/configuration/config/) of the Generic Extractor configuration.



## Basic Configuration Example
Assume you have an API which requires you to use the HTTP Basic authentication to send the login and password in
the `Authorization` header. Assume that your login is `JohnDo` and password is `secret`. The following
configuration solves the situation:

{% highlight json %}
{
"parameters": {
"api": {
"baseUrl": "http://example.com",
"authentication": {
"type": "basic"
}
},
"config": {
"debug": true,
"#username": "JohnDoe",
"#password": "secret",
"outputBucket": "mock-server",
"jobs": [
{
"endpoint": "users"
}
]
}
}
}
{% endhighlight %}

The following HTTP header will be sent:

Authorization: Basic Sm9obkRvZTpzZWNyZXQ=

See [example [EX078]](https://github.com/keboola/generic-extractor/tree/master/doc/examples/078-basic-auth).
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,45 +1,5 @@
---
title: Bearer Token Authentication
permalink: /extend/generic-extractor/configuration/api/authentication/bearer_token/
redirect_to: https://help.keboola.com/components/extractors/generic-extractor/configuration/api/authentication/bearer_token/
---

Bearer token authentication sends a token in the `Authorization` header of each API request.

This method is available through UI. You can select the `Bearer Token` method and fill in the token.

{: .image-popup}
![img.png](/extend/generic-extractor/configuration/api/authentication/bearer.png)



### JSON

In the underlying JSON, the Bearer Token is implemented as follows:

Place your token into the `config.#__BEARER_TOKEN` parameter. The `Authorization` header is then constructed using the `concat` function.

{% highlight json %}
{
"api": {
...,
"http": {
"headers": {
"Authorization": {
"function": "concat",
"args": [
"Bearer ",
{
"attr": "#__BEARER_TOKEN"
}
]
}
}
}
},
"config": {
"#__BEARER_TOKEN": "secret",
"jobs": [...]
}
}
{% endhighlight %}

Loading
Loading