Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kiruyuto/bitrixdailyreportgen

Last synced: 2 days ago
JSON representation

Host: GitHub
URL: https://github.com/kiruyuto/bitrixdailyreportgen
Owner: Kiruyuto
License: mit
Created: 2024-10-25T15:59:22.000Z (about 2 months ago)
Default Branch: master
Last Pushed: 2024-12-18T02:32:50.000Z (5 days ago)
Last Synced: 2024-12-19T05:43:42.400Z (4 days ago)
Language: C#
Homepage:
Size: 274 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # BitrixDailyReportGen

### Installation

1. Grab the [latest release](https://github.com/Kiruyuto/BitrixDailyReportGen/releases/latest) from GH or [pack](https://github.com/Kiruyuto/BitrixDailyReportGen/blob/master/.github/workflows/release.yml#L57) the project yourself.

2. Unzip the archive to a folder of your choice.

3. Run the command below in the terminal to install the tool globally.

    ```bash 

    dotnet tool install --global --add-source ./path/to/directory/containing/.nupkg/ BitrixReportGen

    ```

   which in my case translates to:

    ```bash 

    dotnet tool install --global --add-source ~/Desktop/Repos/ BitrixReportGen

   ```

4. Set the `BITRIX_DOMAIN`, `BITRIX_USER_ID` and `BITRIX_API_KEY` environment variables.

5. You can now run the tool from any directory by typing [**bitrixGen**](https://github.com/Kiruyuto/BitrixDailyReportGen/blob/master/BitrixReportGen/BitrixReportGen.csproj#L10) in the terminal.

    ```bash

    bitrixGen # Or bitrixGen.exe

    ```

   

Example of generated content

```text

# Daily report for 26.10.2024, created at 13:51:48 #

### [Project #1] => 0h 1m 1s ###

- ExampleTask_1 => 0h 1m 0s

- ExampleTask_2 => 0h 0m 1s

Total time spent today across all projects: [0h 1m 1s]

```

# How to get Bitrix24 env vars

### Bitrix Domain

1. Go to main [bitrix page](https://www.bitrix24.net/passport/view/) and copy domain  

  `[unique_domain_id].bitrix24.[domain]` (E.g. `1a2b3c4d.bitrix24.com`)

    

      Open to see image guide

    

      ![domain.png](./.github/imgs/domain.png)

      

    

### User Id

1. Go to your B24 domain profile. You can find your user ID in the URL

  `https://[unique_domain_id].bitrix24.[domain]/company/personal/user/[user_id]/`

  Open to see image guide

  ![iser-id.png](./.github/imgs/user-id.png)

  > [!IMPORTANT]  

  > You must provide your own user ID. Using someone else's ID will result in unauthorized API calls.  

### API Key

1. Go to (Found it navbar) `Developer resources` => `Common use cases` => `Other` =>  `Inbound webhook`

    

      Open to see image guide

      ![developer-resources.png](./.github/imgs/developer-resources.png)  

      ![common-use-casees-other.png](./.github/imgs/common-use-cases-other.png)  

      ![inbound-webhook.png](./.github/imgs/inbound-webhook.png)  

    

2. Assign permissions to the webhook

    

      Open to see image guide

      ![permissions.png](./.github/imgs/permissions.png)  

    

  > [!WARNING]  

  > According to API specs, you should only need few permissions as shown in the image above.  

  > However, there seems to be a bug where you need more permissions to get the webhook to work.  

  > I wasn't able to determine which permissions are necessary, so I assigned all of them.  

  > [See there](./.github/imgs/all-permissions.png).  

  > ¯\\\_(ツ)\_/¯  

3. Click `Generate new` and then copy the key

    

      Open to see image guide

      ![api-key.png](./.github/imgs/api-key.png)