OAuth2 Bearer Token

To get started, a bearer token will need to be created. Using the Minim Care Portal, navigate to the API Keys page. It can be found by clicking the down arrow to the right of the user's email in the upper right-hand corner of the page. You can also find it by going to https://my.minim.co/api_keys.

The page will redirect to the API Keys tab of the account settings. By default, there will not be any API keys enabled. To begin, click the Add API Key button.

A pop-up will appear, type in the name you would like to associate with this API key. Click the Create button when finished.

Another pop-up will appear on the screen. It will show a randomly generated public Application ID and a private secret. Be sure to save this for your records. Minim will not reveal this information again. If you were to lose it, you will need to generate a new API key.

With these credentials, you can generate a time-limited OAuth2 Bearer Token. Replace the APP_ID and APP_SECRET with the credentials generated.

curl -F grant_type=client_credentials \     
     -F client_id=<APP_ID> \    
     -F client_secret=<APP_SECRET> \    
     -X POST https://my.minim.co/api/oauth/token

The response will be a JSON object whose access_token will be the Bearer Token that you may use for making subsequent API calls to Minim.

Finding a LAN associated to a MAC address

Minim API uses the term LAN to refer to subscriber accounts. The Minim Care Portal associates subscriber accounts with MAC addresses. 

To be able to find the LAN_ID, you will first need to learn more about the Unum, or MAC address, of the router or access point.

  curl -X GET https://my.minim.co/api/v1/isps/<ISP_ID>/unums/<MAC_ADDRESS>?access_token=<BEARER_TOKEN>

The response will be a JSON object whose LAN_ID will be the identifier that Minim uses for that subscriber (LAN).

Next, you may query information on that subscriber (LAN).

  curl -X GET https://my.minim.co/api/v1/lans/<LAN_ID>?access_token=<BEARER_TOKEN>

The response is again a JSON object that has all of the attributes for that subscriber.

Updating subscriber information

The request must be of type 'application/json' and the PATCH'd body must be a JSON object:

  curl -X PATCH https://my.minim.co/api/v1/lans/<LAN_ID>?access_token=<BEARER_TOKEN> -H "Content-Type: application/json" --data '{"email": "api@minim.co"}'

To verify that the change has been applied, you may perform a GET on the subscriber and the value will be updated:

  curl -X GET https://my.minim.co/api/v1/lans/<LAN_ID>?access_token=<BEARER_TOKEN>

The response should be a JSON object with the "email" attribute set to "api@minim.co".

If you have any questions about this article or need more information, please contact Minim by emailing support@minim.co.

Did this answer your question?