Cellular, LoRa, and Wi-Fi: Introducing the Next Generation of Notecards

Blues Developers
What’s New
Resources
Accelerators
Fully documented reference applications
Blog
Technical articles for developers
Community
Community projects and resources
Terminal
Connect to a Notecard in your browser
Blues.ioNotehub.io
Shop
Docs
Button IconHelp
Notehub StatusVisit our ForumContact Support
Button IconSign In
Sign In
Sign In
Docs Home
What’s New
Resources
Accelerators
Fully documented reference applications
Blog
Technical articles for developers
Community
Community projects and resources
Terminal
Connect to a Notecard in your browser
Blues.ioNotehub.io
Shop
Docs
API Reference
Glossary
Datasheets
System Notefiles
Notecard API
Introduction
card Requests
dfu Requests
env Requests
file Requests
hub Requests
note Requests
web Requests
Notehub API
API Introduction
Billing Account API
Device API
Environment Variable API
Event API
File API
Fleet API
Note API
Product API
Get ProductsCreate Product
Project API
Route API
Route Logs API

Product API

The Notehub product API provides RESTful methods that can be used to GET and POST product data.

Get Products

Get an array of products from a Notehub project, using a ProjectUID.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

projectUID

string

The ProjectUID of a Notehub project.

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/products'
    -H 'Authorization: Bearer <access_token>'
Response Members

product_uid

string

The globally-unique identifier for the product.

label

string

The user-defined label of the product.

auto_provision_fleets

string

An array of globally-unique FleetUIDs to which new devices will automatically be provisioned.

disable_devices_by_default

boolean

If true, devices provisioned to this product will be automatically disabled by default.

Example Response
{
  "products": [
    {
      "uid": "product:com.your-company.your-name:project",
      "label": "My Notehub Product",
      "auto_provision_fleets": ["fleet:00000000-0000-0000-0000-000000000000"],
      "disable_devices_by_default": false
    }
  ]
}

Create Product

Create a new Notehub product using a ProjectUID.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

projectUID

string

The ProjectUID of a Notehub project.

product_uid

string

The requested ProductUID (without the reverse URL prefix notation).

label

string

The requested label for the product.

fleet_uids

string array (optional)

An array of FleetUIDs to which new devices should be auto-assigned.

disable_devices

boolean (optional)

If true, devices provisioned to this product will be automatically disabled by default.

curl -X POST
     -L 'https://api.notefile.net/v1/projects/<projectUID>/products'
     -H 'Authorization: Bearer <access_token>'
     -d '{"product_uid":"<product_uid>", "label":"<label>"}'
curl -X POST
     -L 'https://api.notefile.net/v1/projects/<projectUID>/products'
     -H 'Authorization: Bearer <access_token>'
     -d '{"product_uid":"<product_uid>", "label":"<label>", "auto_provision_fleets":"{fleet_uids}", "disable_devices_by_default":"{disable_devices}"}'
Response Members

uid

string

The globally-unique identifier for the product.

label

string

The user-defined label of the product.

auto_provision_fleets

string array

The globally-unique fleet identifiers to which new devices will automatically be provisioned.

disable_devices_by_default

boolean

Whether or not new devices will be disabled by default.

Example Response
{
  "uid": "com.blues.test:product",
  "label": "My Product Label",
  "auto_provision_fleets": null,
  "disable_devices_by_default": false
}
Note API Project API
Can we improve this page? Send us feedback
© 2023 Blues Inc.
© 2023 Blues Inc.
TermsPrivacy
Notecard Disconnected
Having trouble connecting?

Try changing your USB cable as some cables do not support transferring data. If that does not solve your problem, contact us at support@blues.com and we will get you set up with another tool to communicate with the Notecard.

Advanced Usage

The help command gives more info.

Connect a Notecard
Use USB to connect and start issuing requests from the browser.
Try Notecard Simulator
Experiment with Notecard's latest firmware on a Simulator assigned to your free Notehub account.

Don't have an account? Sign up