Extend Azure IoT Central with the 1.0 REST APIs to build your production ready solution

Published 05-06-2021 09:00 AM 1,629 Views
Microsoft

IoT Central REST API goes GA!

 

Azure IoT Central REST API is now Generally Available and you can access it through the production 1.0 endpoint. IoT Central is an IoT application platform that reduces the burden and cost of developing, managing, and maintaining enterprise-grade IoT solutions. And with this latest API release, building a companion experience like a field technician application or a web-app to power your business workflows is easier than ever before.

 

Our solution builders can now leverage these APIs and the breadth of the IoT Central extensibility surface to develop production-ready solutions for their customers. Based on customer feedback, we have iterated on our API surface and made new investments to evolve the capabilities further. Using the v1.0 API, you can now:

 

  1. Manage API tokens that provide access to your application.
  2. Create and manage device templates in DTDLv2 format.
  3. Create, onboard, and manage devices within your application.
  4. Retrieve the set of user roles that are defined in your application.
  5. Add, update, and remove users within your application.

The feedback from our customers and partners in the public preview program has helped shaped our 1.0 release. The following set of changes have been introduced in our 1.0 release and we encourage everyone to adapt to this version in their client applications.

 

  1. Support for DTDLv1 based device templates has now been deprecated. All new device templates exported and imported via the 1.0 API surface will be in DTDLv2 format.
  2. We are deprecating management of Applications from our IoT Central API surface. Please use our Azure SDK to manage the IoT Central application instances.
  3. A few routes to manage entities including legacy data exports, device groups and jobs will not be in the 1.0 API surface for this first release.

Take a look at our IoT Central REST API Sample Companion Application on GitHub to get started on your journey with IoT Central. You can leverage the existing samples here to learn more about how to authenticate and authorize to use the Azure IoT Central REST APIs, query data from IoT Central, among other things.

 

Coming soon to our API surface, first through preview and then to our GA branch, is a series of capabilities that will further enhance your device management and data capture experiences. These features include but are not limited to:

 

  1. Ability to programmatically create and manage job instances within your IoT Central application allowing you to manage your connected devices at scale. Jobs let you do bulk updates to device and cloud properties and run commands.
  2. A seamless way to configure our recently announced data export pipeline to route your valuable IoT insights into your business workflows.
  3. A query API enabling you to programmatically access data from within your IoT Central application and power your companion experiences built with IoT Central.

We are committed to continuously improving and adding new capabilities to our IoT Central API surface. If you have any feedback, suggestions, or questions, let us know on our Microsoft Q&A or on Stack Overflow or email us at iotcentralapihelp@microsoft.com.  

 

We can’t wait to see what you’ll build with the IoT Central APIs!

 

%3CLINGO-SUB%20id%3D%22lingo-sub-2323762%22%20slang%3D%22en-US%22%3EExtend%20Azure%20IoT%20Central%20with%20the%201.0%20REST%20APIs%20to%20build%20your%20production%20ready%20solution%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-2323762%22%20slang%3D%22en-US%22%3E%3CH2%20id%3D%22toc-hId--468895116%22%20id%3D%22toc-hId--469761071%22%3EIoT%20Central%20REST%20API%20goes%20GA!%3C%2FH2%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3EAzure%20IoT%20Central%20REST%20API%20is%20now%20Generally%20Available%20and%20you%20can%20access%20it%20through%20the%20%3CA%20href%3D%22https%3A%2F%2Fdocs.microsoft.com%2Frest%2Fapi%2Fiotcentral%2F%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3E%3CSTRONG%3E%3CEM%3Eproduction%201.0%20endpoint%3C%2FEM%3E%3C%2FSTRONG%3E%3C%2FA%3E.%20IoT%20Central%20is%20an%20IoT%20application%20platform%20that%20reduces%20the%20burden%20and%20cost%20of%20developing%2C%20managing%2C%20and%20maintaining%20enterprise-grade%20IoT%20solutions.%20And%20with%20this%20latest%20API%20release%2C%20building%20a%20companion%20experience%20like%20a%20field%20technician%20application%20or%20a%20web-app%20to%20power%20your%20business%20workflows%20is%20easier%20than%20ever%20before.%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3EOur%20solution%20builders%20can%20now%20leverage%20these%20APIs%20and%20the%20breadth%20of%20the%20IoT%20Central%20extensibility%20surface%20to%20develop%20production-ready%20solutions%20for%20their%20customers.%20Based%20on%20customer%20feedback%2C%20we%20have%20iterated%20on%20our%20API%20surface%20and%20made%20new%20investments%20to%20evolve%20the%20capabilities%20further.%20Using%20the%20v1.0%20API%2C%20you%20can%20now%3A%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3COL%3E%0A%3CLI%3EManage%20API%20tokens%20that%20provide%20access%20to%20your%20application.%3C%2FLI%3E%0A%3CLI%3ECreate%20and%20manage%20device%20templates%20in%20%3CA%20href%3D%22https%3A%2F%2Fgithub.com%2FAzure%2Fopendigitaltwins-dtdl%2Fblob%2Fmaster%2FDTDL%2Fv2%2Fdtdlv2.md%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3EDTDLv2%20format%3C%2FA%3E.%3C%2FLI%3E%0A%3CLI%3ECreate%2C%20onboard%2C%20and%20manage%20devices%20within%20your%20application.%3C%2FLI%3E%0A%3CLI%3ERetrieve%20the%20set%20of%20user%20roles%20that%20are%20defined%20in%20your%20application.%3C%2FLI%3E%0A%3CLI%3EAdd%2C%20update%2C%20and%20remove%20users%20within%20your%20application.%3C%2FLI%3E%0A%3C%2FOL%3E%0A%3CP%3EThe%20feedback%20from%20our%20customers%20and%20partners%20in%20the%20public%20preview%20program%20has%20helped%20shaped%20our%201.0%20release.%20The%20following%20set%20of%20changes%20have%20been%20introduced%20in%20our%201.0%20release%20and%20we%20encourage%20everyone%20to%20adapt%20to%20this%20version%20in%20their%20client%20applications.%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3COL%3E%0A%3CLI%3ESupport%20for%20DTDLv1%20based%20device%20templates%20has%20now%20been%20deprecated.%20All%20new%20device%20templates%20exported%20and%20imported%20via%20the%201.0%20API%20surface%20will%20be%20in%20%3CA%20href%3D%22https%3A%2F%2Fgithub.com%2FAzure%2Fopendigitaltwins-dtdl%2Fblob%2Fmaster%2FDTDL%2Fv2%2Fdtdlv2.md%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3EDTDLv2%20format%3C%2FA%3E.%3C%2FLI%3E%0A%3CLI%3EWe%20are%20deprecating%20management%20of%20Applications%20from%20our%20IoT%20Central%20API%20surface.%20Please%20use%20our%20%3CA%20href%3D%22https%3A%2F%2Fdocs.microsoft.com%2Fen-us%2Fazure%2Fiot-central%2Fcore%2Fhowto-manage-iot-central-programmatically%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3EAzure%20SDK%3C%2FA%3E%20to%20manage%20the%20IoT%20Central%20application%20instances.%3C%2FLI%3E%0A%3CLI%3EA%20few%20routes%20to%20manage%20entities%20including%20legacy%20data%20exports%2C%20device%20groups%20and%20jobs%20will%20not%20be%20in%20the%201.0%20API%20surface%20for%20this%20first%20release.%3C%2FLI%3E%0A%3C%2FOL%3E%0A%3CP%3ETake%20a%20look%20at%20our%20IoT%20Central%20REST%20API%20%3CA%20href%3D%22https%3A%2F%2Fgithub.com%2Fiot-for-all%2Fiot-central-rest-api-sample-companion-app%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3ESample%20Companion%20Application%3C%2FA%3E%20on%20GitHub%20to%20get%20started%20on%20your%20journey%20with%20IoT%20Central.%20You%20can%20leverage%20the%20existing%20%3CA%20href%3D%22https%3A%2F%2Fgithub.com%2Fiot-for-all%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3Esamples%20here%3C%2FA%3E%20to%20learn%20more%20about%20how%20to%20authenticate%20and%20authorize%20to%20use%20the%20Azure%20IoT%20Central%20REST%20APIs%2C%20query%20data%20from%20IoT%20Central%2C%20among%20other%20things.%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3EComing%20soon%20to%20our%20API%20surface%2C%20first%20through%20preview%20and%20then%20to%20our%20GA%20branch%2C%20is%20a%20series%20of%20capabilities%20that%20will%20further%20enhance%20your%20device%20management%20and%20data%20capture%20experiences.%20These%20features%20include%20but%20are%20not%20limited%20to%3A%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3COL%3E%0A%3CLI%3EAbility%20to%20programmatically%20create%20and%20manage%20job%20instances%20within%20your%20IoT%20Central%20application%20allowing%20you%20to%20manage%20your%20connected%20devices%20at%20scale.%20Jobs%20let%20you%20do%20bulk%20updates%20to%20device%20and%20cloud%20properties%20and%20run%20commands.%3C%2FLI%3E%0A%3CLI%3EA%20seamless%20way%20to%20configure%20our%20recently%20announced%20data%20export%20pipeline%20to%20route%20your%20valuable%20IoT%20insights%20into%20your%20business%20workflows.%3C%2FLI%3E%0A%3CLI%3EA%20query%20API%20enabling%20you%20to%20programmatically%20access%20data%20from%20within%20your%20IoT%20Central%20application%20and%20power%20your%20companion%20experiences%20built%20with%20IoT%20Central.%3C%2FLI%3E%0A%3C%2FOL%3E%0A%3CP%3EWe%20are%20committed%20to%20continuously%20improving%20and%20adding%20new%20capabilities%20to%20our%20IoT%20Central%20API%20surface.%20If%20you%20have%20any%20feedback%2C%20suggestions%2C%20or%20questions%2C%20let%20us%20know%20on%20our%20%3CA%20href%3D%22https%3A%2F%2Fdocs.microsoft.com%2Fanswers%2Ftopics%2Fazure-iot-central.html%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3EMicrosoft%20Q%26amp%3BA%3C%2FA%3E%20or%20on%20%3CU%3E%3CA%20href%3D%22mailto%3AStack%2520Overflow%22%20target%3D%22_blank%22%20rel%3D%22noopener%20nofollow%20noreferrer%22%3EStack%20Overflow%3C%2FA%3E%3C%2FU%3E%20or%20email%20us%20at%20%3CA%20href%3D%22mailto%3Aiotcentralapihelp%40microsoft.com%22%20target%3D%22_blank%22%20rel%3D%22noopener%20nofollow%20noreferrer%22%3Eiotcentralapihelp%40microsoft.com%3C%2FA%3E.%26nbsp%3B%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3EWe%20can%E2%80%99t%20wait%20to%20see%20what%20you%E2%80%99ll%20build%20with%20the%20IoT%20Central%20APIs!%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%3C%2FLINGO-BODY%3E%3CLINGO-TEASER%20id%3D%22lingo-teaser-2323762%22%20slang%3D%22en-US%22%3E%3CP%3E%3CSPAN%20class%3D%22lia-inline-image-display-wrapper%20lia-image-align-center%22%20image-alt%3D%22IoTCentral-API.png%22%20style%3D%22width%3A%20999px%3B%22%3E%3CIMG%20src%3D%22https%3A%2F%2Ftechcommunity.microsoft.com%2Ft5%2Fimage%2Fserverpage%2Fimage-id%2F278018i4A799241A48FF2D5%2Fimage-size%2Flarge%3Fv%3Dv2%26amp%3Bpx%3D999%22%20role%3D%22button%22%20title%3D%22IoTCentral-API.png%22%20alt%3D%22IoTCentral-API.png%22%20%2F%3E%3C%2FSPAN%3E%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3EAPIs%20are%20the%20digital%20glue%20that%20connect%20different%20systems%20allowing%20builders%20to%20develop%20multi-experience%20ecosystems.%20IoT%20Central%20REST%20API%20enables%20you%20to%20extract%20IoT%20insights%20while%20managing%20your%20devices%20at%20scale%20all%20from%20within%20the%20surface%20of%20your%20choice.%26nbsp%3B%3C%2FP%3E%3C%2FLINGO-TEASER%3E%3CLINGO-LABS%20id%3D%22lingo-labs-2323762%22%20slang%3D%22en-US%22%3E%3CLINGO-LABEL%3EInternet%20of%20Things%3C%2FLINGO-LABEL%3E%3C%2FLINGO-LABS%3E
Co-Authors
Version history
Last update:
‎May 04 2021 02:12 PM
Updated by: