We made a major overhaul to a few screens in the Developer Portal last week. These changes reorganize how key information is presented, and give a substantially richer view of your applications and device types. Read this post to see what’s new!
If you’re developing with SAMI, you have likely used the Developer Portal to register a new application or submit a Manifest for a new device type on SAMI. The dashboard presents a summary of your applications and device types, with the option to “VIEW ALL”.
Previously, the “VIEW ALL” links took you to an expanded list view of your applications and device types. These pages were also accessible by clicking the “Applications” and “Device Types” links on the top bar. Now, you get an information hub divided into two panes.
On the left are your navigation options, including the Overview and a list of your applications/device types. Clicking on Overview gives you the original view, with added details: API calls/hr and errors/hr for each application and device type.
Clicking on the name of the application or device type gives you a metrics page with a date picker, which you can use to find the API calls/hr and errors/hr in a specific date window. Below are the metrics for our Smart Pants last week.
Let’s say we want to update one of your applications. Click the application name, then “Edit App Info”. This brings up the same form you first used to register your application. If you need to update the description, change permissions on any of the associated device types, or add a new device type, it’s easy to do that here.
Some important links are only found on the Device Types side. “Manifests” displays the Manifest version history of your device type and indicates whether the Manifest is Simple or Advanced. If you used an Advanced Manifest for a given version, clicking on it pulls up the entire Groovy script. For a Simple Manifest, you have the option to “View Sample JSON”.
This is also the page where you can add a new Manifest version, by clicking the “+ Manifest” button on the upper-right. You’ll be able to create and submit a Simple Manifest or Advanced Manifest via the usual process.
The “Status” page meanwhile lets you Publish any of your device types that are still Private. Doing so lets all SAMI developers use this device type.
Finally, the “Errors” page under both Applications and Device Types displays total error counts, error rate, and errors/hr according to a window set in the date picker. Below these stats is a table of each error logged, including its error code, error message, date and time. See the API specification for a list of common error codes. It looks like our Smart Pants may not really exist:
Clicking on an error in the table expands that row to display the error ID and application or device type ID. And if you click the little “pop out” icon to the right of the error message, you will get the following summary that also includes the associated user ID:
So obviously, this new setup is very handy for debugging—but we hope you won’t have to use it too much!
Top image: tanakawho