# API Manager

### Generating API Key

* [ ] [Login ](https://brandmeister.network/?page=login)to Brandmeister Dashboard.&#x20;

* [ ] Click your call sign at the top right to reveal the menu options. <br>

  <figure><img src="https://4155604118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lwt5_fD727PWKbcmY4u%2Fuploads%2FlnVmiTyv66Mlr8LmLFZS%2Fimage.png?alt=media&#x26;token=34585e22-3771-489a-8067-4c83a22f4a75" alt="" width="341"><figcaption></figcaption></figure>

* [ ] Click on "Profile Settings" as shown above.

* [ ] Click on "API Keys" button under the Security Settings section.<br>

  <figure><img src="https://4155604118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lwt5_fD727PWKbcmY4u%2Fuploads%2F1B8lrqbfl35MQU7tXOrB%2Fimage.png?alt=media&#x26;token=b10c97e7-b9ac-49d5-8c94-b50f4914b485" alt="" width="375"><figcaption></figcaption></figure>

* [ ] Click on the "Add" button located top right of the screen.<br>

  <figure><img src="https://4155604118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lwt5_fD727PWKbcmY4u%2Fuploads%2FirTToksMIK9e5tTiIJtq%2Fimage.png?alt=media&#x26;token=8f04df55-ecb8-437d-99c7-57131cfa8262" alt="" width="375"><figcaption></figcaption></figure>

* [ ] Enter a name for the API Key. This can be the name of your hotspot for example. Click OK.\ <br>

  <figure><img src="https://4155604118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lwt5_fD727PWKbcmY4u%2Fuploads%2FNERBx34tqgzjYMHit5mH%2Fimage.png?alt=media&#x26;token=7c5605cd-4e21-4139-a99c-e8d36b7ec22c" alt="" width="345"><figcaption></figcaption></figure>

* [ ] Click the "Copy" button to copy the API Key. This will copy the key needed in a future step. You may also save this into a text editor of your choice. Click OK to exit. <br>

  <figure><img src="https://4155604118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lwt5_fD727PWKbcmY4u%2Fuploads%2FKSC3QB5Fu4G4Sz5Ho3Bi%2Fimage.png?alt=media&#x26;token=d41fe4e2-0301-4433-bc63-e5341b42764d" alt="" width="234"><figcaption></figcaption></figure>

### Adding API Key to Pi-Star Dashboard

* [ ] Login to your hotspot, you can use <http://pi-star> or <http://pi-star.local> or the IP address of your hotspot to access your dashboard.&#x20;
* [ ] Click on Configuration Link at the top right. <br>

  <figure><img src="https://4155604118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lwt5_fD727PWKbcmY4u%2Fuploads%2F3m5sobGM9SM0FNWbG9T0%2Fimage.png?alt=media&#x26;token=4106db54-b82b-47c0-a60b-8ddf46bdfa09" alt="" width="375"><figcaption></figcaption></figure>
* [ ] Click the "Expert" link.<br>

  <figure><img src="https://4155604118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lwt5_fD727PWKbcmY4u%2Fuploads%2FNaTcMeURoi5aaZwhAfWV%2Fimage.png?alt=media&#x26;token=d8efcbbe-35e1-42e9-9bf6-1dc6b1b81a7e" alt="" width="375"><figcaption></figcaption></figure>
* [ ] Click the "BM API" Link<br>

  <figure><img src="https://4155604118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lwt5_fD727PWKbcmY4u%2Fuploads%2F0txFc62qDJqj1lP0hnsv%2Fimage.png?alt=media&#x26;token=42ea3ddc-0d75-4e3f-8596-80b290c7f44f" alt="" width="375"><figcaption></figcaption></figure>
* [ ] Paste the API Key copied above into the "APIKEY" Textbox. then click "Apply changes" button to save.<br>

  <figure><img src="https://4155604118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lwt5_fD727PWKbcmY4u%2Fuploads%2FB6k2umuayQjgcUWF9PNS%2Fimage.png?alt=media&#x26;token=11f3b0dd-be6c-4e08-a477-d889371cda42" alt="" width="363"><figcaption></figcaption></figure>
* [ ] You are now setup to use the API Manager in Pi-Star Dashboard.

### Accessing the API Manager on Pi-Star

* [ ] Click on the "Admin" link on your pi-star based hotspot.<br>

  <figure><img src="https://4155604118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lwt5_fD727PWKbcmY4u%2Fuploads%2FnAkijdbw5nIQpwWkHkxT%2Fimage.png?alt=media&#x26;token=e28d6b9b-a394-4a4a-860a-06bdfa0d1835" alt="" width="563"><figcaption></figcaption></figure>
* [ ] You will see the following section showing current Static and Dynamic TGs (if any) and the options to add or remove static talk groups. <br>

  <figure><img src="https://4155604118-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lwt5_fD727PWKbcmY4u%2Fuploads%2FSWA1KZApTLBroRp0wZ6W%2Fimage.png?alt=media&#x26;token=6e65c669-1649-4fb8-98e1-6ad12ec16329" alt=""><figcaption></figcaption></figure>
* [ ] **Add Static TG:** Enter the TG ID in the Static Talkgroup field, next click on TS1 or TS2 radio button (if using a duplex you will see TS1 and TS2, if simplex you wont see this), then click Add radio button to add the TG and finally click on "Modify Static" button.  This will now appear under the Static TGs section.
* [ ] **Remove Static TG**: Enter the TG ID in the Static Talkgroup field, next click on TS1 or TS2 radio button (if using a duplex you will see TS1 and TS2, if simplex you wont see this), then click Delete radio button to delete the TG and finally click on "Modify Static" button.  This will now remove the Static TG.
* [ ] **Drop QSO:** This will drop the current user if you want to stop the QSO so you can move or change the TG.
* [ ] **Drop All Dynamic:** This will allow you to drop all Dynamic TGs if you had keyed up a TG using your radio.&#x20;
