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

#25108 update api key action images and co rest operation image #269

Merged
merged 3 commits into from
Aug 2, 2024
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
2 changes: 1 addition & 1 deletion docs/API/content-objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The supporting endpoints of a given
<abbr title="Content Type - a model of data that has been defined inside the Content Repository.">Content Type</abbr>
allow the user to perform basic REST operations

![](images/endpoints.png){: .center .width75 .border}
![](images/endpoints.png){: .border}

* [Create](content-type/creating-co.md)
* [Batch create](/docs/API/content-type/creating-co/#batch-create-content-objects-through-api)
Expand Down
Binary file added docs/API/images/api_doc_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/API/images/copy_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/API/images/endpoints.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/API/images/qr_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/API/images/regenerate_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/API/images/remove_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 6 additions & 5 deletions docs/API/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@ Every Flotiq account has 2 Application API keys - read-write and read-only. Appl

![](images/api-keys_1.png){: .center .width75 .border}

All keys can be copied using ![](images/copy_icon.png){: style="margin-bottom: -7px;"} button.
You can open QR code with the key using ![](images/qr_button.png){: style="margin-bottom: -7px;"} button,
and you can regenerate keys using ![](images/regenerate_button.png){: style="margin-bottom: -7px;"} button.
Only user defined keys can be removed using ![](images/remove_button.png){: style="margin-bottom: -7px;"} button.
All keys can be copied using ![](images/copy_icon.png){: style="margin-bottom: -7px; height:1.5em"} button.
You can open QR code with the key using ![](images/qr_button.png){: style="margin-bottom: -7px; height:1.5em"} button,
you can regenerate keys using ![](images/regenerate_button.png){: style="margin-bottom: -7px; height:1.5em"} button, and
you can generate API docs for key using ![](images/api_doc_icon.png){: style="margin-bottom: -7px; height:1.5em"} button.
Only user defined keys can be removed using ![](images/remove_button.png){: style="margin-bottom: -7px; height:1.5em"} button.

!!! hint
You can use the QR code of your API keys to authorize your Flotiq Mobile Expo installation to access your data. Head over to the [Flotiq Mobile Expo repository](https://github.com/flotiq/flotiq-mobile-demo) to learn more.
Expand Down Expand Up @@ -188,7 +189,7 @@ Or an example queries with `X-AUTH-TOKEN` header:

### What can I do if my API key got compromised?

If you accidentally committed your `.env` file to a public repository or in any other way shared your key publicly - you can regenerate the key using the ![](images/regenerate_button.png){: style="margin-bottom: -7px;"} button.
If you accidentally committed your `.env` file to a public repository or in any other way shared your key publicly - you can regenerate the key using the ![](images/regenerate_button.png){: style="margin-bottom: -7px; height:1.5em"} button.

### How can I provide read-only access to a single kind of data?

Expand Down
Loading