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

From PiStar Wiki
Jump to navigationJump to search
Line 1: Line 1:
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;
+
== BrandMeister API Integration ==
 +
 
 +
Pi-Star has had some basic integration with the BrandMeister API for some time, allowing information about your repeater or hotspot
 +
 
 +
to be read from the BrandMeister network, however all of this information was only available as read-only;
  
 
Until now that is...
 
Until now that is...
  
Step 1 - Obtain your BrandMeister API Key:   
+
'''Step 1 - Obtain your BrandMeister API Key:'''  
 
Login to the BrandMeister dashboard at: https://brandmeister.network [https://brandmeister.network]
 
Login to the BrandMeister dashboard at: https://brandmeister.network [https://brandmeister.network]
  
 +
Click your callsign at the top right
  
Step 2 - Click your callsign at the top right
+
[[Image:BM_API_Callsign.png|600px]]
 
 
[[File:BM_API_Callsign.png]]
 
  
 
Click the "Profile Settings" option.
 
Click the "Profile Settings" option.
Line 15: Line 18:
 
On the new page, click the "API Keys"
 
On the new page, click the "API Keys"
  
[[Image:BM_API_Keys1.png|100]]
+
[[Image:BM_API_Keys1.png|600px]]
  
  
 
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.
  
[[File:BM_API_Keys2.png]]
+
[[Image:BM_API_Keys2.png|600px]]
  
 
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"
  
[[File:BM_API_Keys3.png]]
+
[[Image:BM_API_Keys3.png|600px]]
  
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
  
[[File:BM_API_Keys4.png]]
+
(right click, copy) for use on the Pi-Star dashboard in the next step.
 +
 
 +
[[Image:BM_API_Keys4.png|600px]]
  
 
Once you have the text copied, press the OK button.
 
Once you have the text copied, press the OK button.
  
  
Step 3
+
'''Step 2 - Add your key to PI-Star'''
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 [http://pi-star.local/admin/expert/edit_bmapikey.php]
+
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 [http://pi-star.local/admin/expert/edit_bmapikey.php]
  
Here we enter the API key we obtained in Step 2.
+
Here we enter the API key we obtained in Step 1.
 
Paste the key into the box, and apply the changes;
 
Paste the key into the box, and apply the changes;
  
[[File:BM_API_Dash1.png]]
+
[[Image:BM_API_Dash1.png|600px]]
  
 
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:
  
[[File:BM_API_Dash2.png]]
+
[[Image:BM_API_Dash2.png|600px]]

Revision as of 12:09, 3 March 2018

BrandMeister API Integration

Pi-Star has had some basic integration with the BrandMeister API for some time, allowing information about your repeater or hotspot

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]

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 2 - Add your key to PI-Star 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 1. 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