This article is related to the PurpleAir API. If you are unfamiliar with it, check out our About the PurpleAir API page to get started.
Develop.purpleair.com allows users to edit, create, and manage their API keys and usage.
Structure
API keys now belong to projects, and projects belong to organizations. This hierarchy will allow users to stay organized and simply control their API usage.
Tabs
Organizations
The Organizations tab is what’s opened after log in. This displays the high-level details of your organization using pie charts and a usage graph.
You can change your organization’s name by clicking the " Edit button. in the top right.
Organization Usage Graph
The Organization usage graph is quite configurable.
- Selecting “View By” will change what is displayed in the pie charts and the table below the usage graph.
- Applying filters will affect all data shown. Multiple filters can simultaneously be applied to different resources (Projects, API Keys, or Endpoints).
Projects
The Projects tab will display the projects within your organization. New projects can be created by clicking the + Project button in the top-right corner.
Once a project has been completed and is no longer needed, it can be archived by clicking the three dots next to the project name and selecting the Archive option. Archiving a project is permanent and cannot be undone.
API Keys
The API Keys tab displays all API keys in your organization. You can create a new API key by clicking the + API Key button in the top-right corner. For more information on creating API keys, view the article Creating API Keys.
To edit an API key, you can click the actions menu to the right. This will let you change various information for the key. However, the key’s type (read or write) cannot be changed after creation.
Once an API key is no longer needed, it can be archived by clicking the three dots on the right and selecting the Archive option. Archiving an API key is permanent and cannot be undone.
Logs
While usage graphs allow you to see overall trends in your usage, you can use the Logs Explorer to view details specific to an individual API call.
Users
The Users tab displays all users under your organization. API keys must have a user assigned to them, which can be set to any user in the organization while being created. The name of a user can be edited by clicking the three dots to the right and selecting the Edit User button.
To add another user to your organization, send an email to contact@purpleair.com.
Points
API usage consumes points. If a user does not have enough points in their organization to make an API call, the API will return a “PaymentRequiredError.” To fix this, points must be added to your account.
Sensor owners can query data from their devices for free. For further details, see API Points for Sensor Owners.
Learn More
How to Make Efficient API Calls
API Points for Sensor Owners
API Pricing