This article was originally published in 03/2022 has been updated on 08/2022 to add keys versions.
Any BrandMeister user can generate an API key. A key is a long string of characters that is unique to a Brandmeister user account. This digital key allows a third-party application to read and update the data on the corresponding Brandmeister Account (such as your list of hotspots, repeaters, your static talkgroups, etc.).
API keys were first introduced in Brandmeister in 2018, as API v1. In August 2022, developers improved the API features and created API v2, which changed the keys format.
An API v1 key is a 128-character string. For example:
MWaztB3EcHWBEW@D$2gb89Y2kvvE4leSr.33Gey74d0IYVSKU58YGMSFmPHD.Q1fECUkIcj7E4leSr.33Getkjshdf987ywe2irligr908SFIdlsfkj08934sasdlveg
The most recent API v2 key is a 983-character string. For example:
jh7KJSAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiOWVjYjBhODRmYTAwODdkNjQ2YmNmNWJlMGJjMGEyZDQ0YmUxNGFkNDllNmM5OWNhM2NkNTcyNjViOGNjYjJmN2ZlNThlYzI1MjNhZWM2YTQiLCJpYXQiOjE2NjA5MzI0NjIuMDI5NzEyLCJuYmYiOjE2NjA5MzI0NjIuMDI5NzE1LCJleHAiOjQ4MTY2MDYwNjIuMDA3OTIyLCJzdWIiOiIxOTIiLCJzY29wZXMiOltdfQ.PnoQ3LkPeuV1TW1Hggn-D7Lloq3TRIB0bHEXTC3Ck1zXDqJRXvjf74sSJ01RSCDCOEAzyDW8eYDjguswGOjMmJ3Lp0IPAcSU7yZY3cjz7NNuFbiqllyV_jXYoBybU-FzSEuoEl3Nx6kbO6iNb_IoDrdloRxVtEDsQJ8Q27FouzMcf3lSxriwmC3tVv2V5phqzJlT-DyL0QLgZaRyDnRdxJtq6yLW5EPUAK6uAHRANCs_wbeSAKVZmqC6ycLJ0ZfIvbUBr7312HP8u2kInh1vcpnNczWyoc7FsjcZjBYrMskt7zRds051a_KqoP8uzUUSS9ZZSxrd_KDozUQ6CiWSB7nCc96B4KLY4CCpJq50I1RSnxrg4Pamj8b8abdO6O5yGakUDrp0t1jMONhOb_B9SlyNgy55SxY2ZC0Q9h3MNC1fxw_rKd73wWjD1SWsW2SI1iaAZA6ewLbn5xPpHvUlVtNri0ZO2oPfdn_1nRImCAwlYKt4LbUKmAFp-vgshMknVlVwutDNQ815y9M3F994Za_OghmAylUaWDextUh6Kx4eYAZuNnB6OphDwS08dWUZOe7MEMBH1OM2Sw_GbbjGPiS82pUDqPZzkfjs5ghFS1CfAu1BB8Teh0wgLqevWaN7VLJWOSSgl9-IOAdSSphmH0yprWbuZHPNyWq1HDY_eEI
Using an API key, you can use a third-party software or hardware appliance to read and manage the information on your Brandmeister Selfcare account (including repeaters, hotspots, talkgroups configuration, etc.). Using an API key allows you to keep your SelfCare username and password confidential and to have granular control over each key you provide to others.
The API key is completely unrelated to your SelfCare password. If you change your SelfCare password, the keys you have generated are still valid.
At any time you can Revoke a key, and any person or application with this key will no longer be able to access the information and features of your personal SelfCare account.
To generate an API key, follow these steps:
This is the only time the key code and barcode will be visible. Once you click “OK” only the key name will be available in your list. There is no need to keep a copy of your key somewhere, considering that you can always revoke and generate a new key.
BE EXTREMELY CAREFUL TO WHOM YOU GIVE YOUR KEY, TO AND WHERE YOU SAVE YOUR KEY. THE KEYS ALLOW A COMPLETE AND FULL ACCESS TO ALL THE FEATURES OF YOUR PERSONAL SELF-CARE. THIS INCLUDES REPEATER/MASTER SYSOP FUNCTIONS!
Your password is confidential and should never be given to others. Providing a separate key to each third-party allow you better control: if you provided your account password, each time you want to change the password you will have to go back to each third party to update it. With the API keys, you can change your SelfCare account password or revoke a key without affecting all other keys you have already provided.
There are currently three developers we have worked with to develop the first applications leveraging user API keys:
This application for Android devices allows you to manage your hotspot or repeater directly from your mobile device, without having to go through the web-based SelfCare interface. Once you have registered your user API key, no further password will ever be required. And the application will continue to work and properly authenticate with your SelfCare account even if you change your SelfCare password using the web-based interface.
Pi-Star is a custom, pre-configured SD Card image for the Raspbperry Pi, built on Raspbian Linux. It includes software stacks by G4KLX, MMDVMHost / DStarRepeater, and associated tools & programs.
Its built-in dashboard now includes the ability to make changes to users’ BrandMeister configuration, by leveraging the use of APIs.
Repeater Reader is a small JAVA program that creates visibility and management options for the selected repeater or hotspot. It will also get support for controlling the repeater through APIs.
The BrandMeister team wishes to thank all application developers for making all of this happen!
Brandmeister’s developers will be rolling out a major code upgrade in the upcoming days. Please read below to learn about the impact of this upgrade.
New user registrations, password changes/resets, and accounts activations will be paused the entire day of August 19th 2022.
Current API (v1) will be upgraded to a new v2. The API keys format is evolving and is not backward compatible.
On August 19th, 2022, old API v1 keys will no longer be showing up on the Selfcare Profile screen. New keys that you add using the “+ Add Key” button will be in API v2 format.
It is therefore normal to see an empty list of API keys in your Selfcare Profile screen after August 19th, 2022.
While you won’t be able to add API v1 keys anymore, your existing ones will continue to work on hotspots for managing static talkgroups and such, but will be retired within a few months. We encourage you to migrate your API keys to the new version as soon as possible. The latest version of Pi-Star is already API v2 compatible. For other devices, please contact the manufacturer to inquire about compatibility.
Simply put, the current code base is reaching its limit and is hindering our ability to build new features.
This article will be updated with any frequent questions we might receive.