Difference between revisions of "PI-Star integration with BrandMeister API"

From PiStar Wiki
Jump to navigationJump to search
(Created page with "Pi-Star has had some basic integration with the BrandMeister API for some time, allowing information about your repeater to be read from the BrandMeister network, however all...")
 
Line 7: Line 7:
  
 
Step 2 - Click your callsign at the top right
 
Step 2 - Click your callsign at the top right
--bmapi callsign--
+
[[File:BM_API_Callsign.png]]
  
 
Click the "Profile Settings" option.
 
Click the "Profile Settings" option.
 
On the new page, click the "API Keys"
 
On the new page, click the "API Keys"
--bmapi keys1--
+
[[File:BM_API_Keys1.png]]
  
 
Now on the API Keys page, click the "Add" button on the right hand side.
 
Now on the API Keys page, click the "Add" button on the right hand side.
--bmapi keys2--
+
[[File:BM_API_Keys2.png]]
  
 
You will be prompted to give this key a name, for this example I call it "Pi-Star"
 
You will be prompted to give this key a name, for this example I call it "Pi-Star"
--bmapi keys 3 --
+
[[File:BM_API_Keys3.png]]
  
 
Now you will be presented with your API key, you will want to select all of the text in the text area at the top, and copy that (right click, copy) for use on the Pi-Star dashboard in the next step.
 
Now you will be presented with your API key, you will want to select all of the text in the text area at the top, and copy that (right click, copy) for use on the Pi-Star dashboard in the next step.
--bmapi keys 4--
+
[[File:BM_API_Keys4.png]]
  
 
Once you have the text copied, press the OK button.
 
Once you have the text copied, press the OK button.
Line 29: Line 29:
  
 
Paste the key into the box, and apply the changes;
 
Paste the key into the box, and apply the changes;
--bmapi dash1--
+
[[File:BM_API_Dash1.png]]
  
 
Thats all there is to it, the next time you use the "Admin" link in Pi-Star, you will now have access to the API features that look like the below:
 
Thats all there is to it, the next time you use the "Admin" link in Pi-Star, you will now have access to the API features that look like the below:
--bmapi dash2--
+
[[File:BM_API_Dash2.png]]

Revision as of 12:00, 3 March 2018

Pi-Star has had some basic integration with the BrandMeister API for some time, allowing information about your repeater to be read from the BrandMeister network, however all of this information was only available as read-only;

Until now that is...

Step 1 - Obtain your BrandMeister API Key; Login to the BrandMeister dashboard at: https://brandmeister.network [1]

Step 2 - Click your callsign at the top right BM API Callsign.png

Click the "Profile Settings" option. On the new page, click the "API Keys" BM API Keys1.png

Now on the API Keys page, click the "Add" button on the right hand side. BM API Keys2.png

You will be prompted to give this key a name, for this example I call it "Pi-Star" BM API Keys3.png

Now you will be presented with your API key, you will want to select all of the text in the text area at the top, and copy that (right click, copy) for use on the Pi-Star dashboard in the next step. BM API Keys4.png

Once you have the text copied, press the OK button.

Step 3 Navigate to your Pi-Star Dashboard, we need a page that is not currently available as a link (although it will be added soon): http://pi-star.local/admin/expert/edit_bmapikey.php [2] Here we enter the API key we obtained in Step 2.

Paste the key into the box, and apply the changes; BM API Dash1.png

Thats all there is to it, the next time you use the "Admin" link in Pi-Star, you will now have access to the API features that look like the below: BM API Dash2.png