Introduction to the API Docs

This quickstart will demonstrate using the API Docs to create a new device.

avhsupport avatar
Written by avhsupport
Updated over a week ago

This quickstart will demonstrate using the API Docs to create a new device. It will include logging in, setting the API Token, finding your project ID, and finally creating the device.

  1. Log in to AVH with your Arm user account.
    โ€‹https://avh.arm.com/ If you do not have or need to create an Arm account register at https://developer.arm.com/

  2. To retrieve your API Token, follow the steps in generating an AVH API Token article.

  3. Next, go to the AVH API Docs https://app.avh.arm.com/api/docs

  4. Click on "Log In" on the menu.

  5. Paste the API Token you generated into the example request replacing <token>, then click "TRY".

  6. You can now see your auth token in the response. Copy just the value of the token. We are going to use this in the HTTP Bearer.

  7. Click "Authentication" in the menu.

  8. Paste your auth token in the input and click "SET"

  9. Click "Get Projects"

  10. Click "TRY" to get your project's information. Copy the id from the JSON, you will need this to create the device.

  11. In the menu click "Create Instance"

  12. We are going to create a STM32U5 IoT Discovery Kit device and name it "STM32U5 created via API". Paste the object into the example replacing the sample object with your project id.

    {
    "project": "<your_project_id>",
    "name": "stm32u5 Created via API",
    "flavor": "stm32u5-b-u585i-iot02a",
    "description": "STM32U5 IoT Discovery Kit",
    "model": "stm32u5-b-u585i-iot02a",
    "os": "1.1.0"
    }

    Once you have added this click "Try"

    Note you can find information about the models and the software for the models in the API Doc

  13. The response will show that the device status is being created.

  14. When you go back to AVH the devices list will be the device we created in this quickstart guide.

    The API Docs has a rich set of features to programmatically use AVH devices for your use cases.

.

Did this answer your question?