Skip to content

Commit

Permalink
Создание MD файлов документации
Browse files Browse the repository at this point in the history
  • Loading branch information
VitalyTheAlpaca committed Jun 21, 2024
1 parent 2f1965c commit 96b2149
Show file tree
Hide file tree
Showing 20 changed files with 948 additions and 948 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_position: 7
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| PostID | --postid | String, Number | Post ID |
| Visibility | --vision | String | Array or a single post target: UA all, SG<X> work group, U<X> user, DR<X> depart., G<X> group |
| Visibility | --vision | String | Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group |
| Token | --token | String | Access token, when not-webhook method used |


Expand Down
2 changes: 1 addition & 1 deletion docs/en/md/Bitrix24/Feed-posts-managment/Create-post.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_position: 1
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Text | --text | String | Text of post |
| Visibility | --vision | String | Array or a single post target: UA all, SG<X> work group, U<X> user, DR<X> depart., G<X> group |
| Visibility | --vision | String | Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group |
| Files | --files | String | Attachment data where key > filename, value > file path or binary data |
| Title | --title | String | Post title |
| Important | --important | Boolean | Mark post as important |
Expand Down
2 changes: 1 addition & 1 deletion docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebar_position: 2
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| PostID | --postid | String, Number | Post ID |
| Text | --text | String | Text of post |
| Visibility | --vision | String | Array or a single post target: UA all, SG<X> work group, U<X> user, DR<X> depart., G<X> group |
| Visibility | --vision | String | Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group |
| Files | --files | String | Attachment data where key > filename, value > file path or binary data |
| Title | --title | String | Post title |
| Token | --token | String | Access token, when not-webhook method used |
Expand Down
48 changes: 24 additions & 24 deletions docs/en/md/Instructions/Airtable.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
---
id: Airtable
sidebar_class_name: Airtable
---

<img src={require('../../static/img/APIs/Airtable.png').default} width='64px' />

# Airtable

This section is dedicated to the library for working with Airtable API. On this page, all the steps necessary to start working are described

## Getting started

1. Sign in to Airtable and go to the **[personal tokens creation page](https://airtable.com/create/tokens)**, press **Create new token**

![BF](../../static/img/Docs/Airtable/1.png)

2. Enter a name for the new token, select the necessary **scopes** (permissions), and choose the databases and workspaces to which the token will have access

![BF](../../static/img/Docs/Airtable/2.png)

3. Copy the new **token**

![BF](../../static/img/Docs/Airtable/3.png)
---
id: Airtable
sidebar_class_name: Airtable
---

<img src={require('../../static/img/APIs/Airtable.png').default} width='64px' />

# Airtable

This section is dedicated to the library for working with Airtable API. On this page, all the steps necessary to start working are described

## Getting started

1. Sign in to Airtable and go to the **[personal tokens creation page](https://airtable.com/create/tokens)**, press **Create new token**

![BF](../../static/img/Docs/Airtable/1.png)

2. Enter a name for the new token, select the necessary **scopes** (permissions), and choose the databases and workspaces to which the token will have access

![BF](../../static/img/Docs/Airtable/2.png)

3. Copy the new **token**

![BF](../../static/img/Docs/Airtable/3.png)
124 changes: 62 additions & 62 deletions docs/en/md/Instructions/Bitrix24.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,62 @@
---
id: Bitrix24
sidebar_class_name: Bitrix24
---

<img src={require('../../static/img/APIs/Bitrix24.png').default} width='64px' />

# Bitrix24

This section is dedicated to the library for working with Bitrix24 API. On this page, all the steps necessary to start working are described

## Getting started

There are two ways to work with Bitrix24 via API: via **Webhook** and via **local application**. For both options you need:

1. Go to **Developers** in the **Applications** section of the sidebar

![BF](../../static/img/Docs/Bitrix24/1.png)

2. Select **Other**

![BF](../../static/img/Docs/Bitrix24/2.png)

<hr/><br/>

### To work via Webhook

1. Select **Incoming Webhook**

![BF](../../static/img/Docs/Bitrix24/3.png)

2. Fill in the necessary permissions in **Permissions Settings** and save the URL of the webhook. This will be used to execute library methods as the **URL** parameter. The optional **Token** parameter will always remain empty in this case

![BF](../../static/img/Docs/Bitrix24/4.png)

<hr/><br/>

## To work via Local Application

1. Select **Local Application**

![BF](../../static/img/Docs/Bitrix24/5.png)

2. Select the path of the handler (if the application does not imply authorization of other users, but only Bitrix management through one administrator account, you can choose any address, for example https://localhost), tick **Use only API** (if you need only the functionality of calling library methods) and fill in the necessary permissions

![BF](../../static/img/Docs/Bitrix24/6.png)

3. Save the **application key** and **application code**

![BF](../../static/img/Docs/Bitrix24/7.png)

4. Using the application key, call the **GetAppAuthLink** function and follow the received link in the browser. After authorization, copy the received code from the address bar (or get it to the handler whose address was specified in point 2)

![BF](../../static/img/Docs/Bitrix24/8.png)

5. Pass the received code, along with the application key and secret, to the **GetToken** function. Save the received **access** and **refresh tokens**

6. Tokens have a limited lifetime. To get a new token, you can use the **UpdateToken** function, passing here the refresh token, key and application secret. The refresh creates not only a new access token, but also a refresh token as well




---
id: Bitrix24
sidebar_class_name: Bitrix24
---

<img src={require('../../static/img/APIs/Bitrix24.png').default} width='64px' />

# Bitrix24

This section is dedicated to the library for working with Bitrix24 API. On this page, all the steps necessary to start working are described

## Getting started

There are two ways to work with Bitrix24 via API: via **Webhook** and via **local application**. For both options you need:

1. Go to **Developers** in the **Applications** section of the sidebar

![BF](../../static/img/Docs/Bitrix24/1.png)

2. Select **Other**

![BF](../../static/img/Docs/Bitrix24/2.png)

<hr/><br/>

### To work via Webhook

1. Select **Incoming Webhook**

![BF](../../static/img/Docs/Bitrix24/3.png)

2. Fill in the necessary permissions in **Permissions Settings** and save the URL of the webhook. This will be used to execute library methods as the **URL** parameter. The optional **Token** parameter will always remain empty in this case

![BF](../../static/img/Docs/Bitrix24/4.png)

<hr/><br/>

## To work via Local Application

1. Select **Local Application**

![BF](../../static/img/Docs/Bitrix24/5.png)

2. Select the path of the handler (if the application does not imply authorization of other users, but only Bitrix management through one administrator account, you can choose any address, for example https://localhost), tick **Use only API** (if you need only the functionality of calling library methods) and fill in the necessary permissions

![BF](../../static/img/Docs/Bitrix24/6.png)

3. Save the **application key** and **application code**

![BF](../../static/img/Docs/Bitrix24/7.png)

4. Using the application key, call the **GetAppAuthLink** function and follow the received link in the browser. After authorization, copy the received code from the address bar (or get it to the handler whose address was specified in point 2)

![BF](../../static/img/Docs/Bitrix24/8.png)

5. Pass the received code, along with the application key and secret, to the **GetToken** function. Save the received **access** and **refresh tokens**

6. Tokens have a limited lifetime. To get a new token, you can use the **UpdateToken** function, passing here the refresh token, key and application secret. The refresh creates not only a new access token, but also a refresh token as well




80 changes: 40 additions & 40 deletions docs/en/md/Instructions/Dropbox.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
---
id: Dropbox
sidebar_class_name: Dropbox
---

<img src={require('../../static/img/APIs/Dropbox.png').default} width='64px' />

# Dropbox

This section is dedicated to the library for working with Dropbox API. On this page, all the steps necessary to start working are described

## Getting started

1. Login to [Dropbox Developers](https://www.dropbox.com/developers)

![BF](../../static/img/Docs/Dropbox/1.png)

1. Go to **App Console**

![BF](../../static/img/Docs/Dropbox/2.png)

2. Click on **Create app**

![BF](../../static/img/Docs/Dropbox/3.png)

4. Enter a name for the new application and select **Full Dropbox**

![BF](../../static/img/Docs/Dropbox/4.png)

5. After creation, on the application page, click **Scoped app** and select the permissions that are necessary to solve your problems. Save **AppKey** and **AppSecret**

![BF](../../static/img/Docs/Dropbox/5.png)

6. Get the authorization link using the *GetAuthorizationLink()* function and pass it in the browser

![BF](../../static/img/Docs/Dropbox/6.png)

7. Pass the **received code**, **AppKey** and **AppSecret** to the function *GetToken()*, save the received **access_token** and **refresh_token**

8. After the access_token lifetime expires, it can be updated using the function *RefreshToken()*
---
id: Dropbox
sidebar_class_name: Dropbox
---

<img src={require('../../static/img/APIs/Dropbox.png').default} width='64px' />

# Dropbox

This section is dedicated to the library for working with Dropbox API. On this page, all the steps necessary to start working are described

## Getting started

1. Login to [Dropbox Developers](https://www.dropbox.com/developers)

![BF](../../static/img/Docs/Dropbox/1.png)

1. Go to **App Console**

![BF](../../static/img/Docs/Dropbox/2.png)

2. Click on **Create app**

![BF](../../static/img/Docs/Dropbox/3.png)

4. Enter a name for the new application and select **Full Dropbox**

![BF](../../static/img/Docs/Dropbox/4.png)

5. After creation, on the application page, click **Scoped app** and select the permissions that are necessary to solve your problems. Save **AppKey** and **AppSecret**

![BF](../../static/img/Docs/Dropbox/5.png)

6. Get the authorization link using the *GetAuthorizationLink()* function and pass it in the browser

![BF](../../static/img/Docs/Dropbox/6.png)

7. Pass the **received code**, **AppKey** and **AppSecret** to the function *GetToken()*, save the received **access_token** and **refresh_token**

8. After the access_token lifetime expires, it can be updated using the function *RefreshToken()*
Loading

0 comments on commit 96b2149

Please sign in to comment.