Version: 2.0.0

This resource provides a concise overview of the Podero API endpoints, designed for interacting with and governing its hardware and features.

Table of Contents

Versioning

Podero’s API follows a versioning approach to ensure stability and compatibility. New versions of the API are issued when significant changes occur or new features are introduced that may break existing functionality. Bug fixes are made available across all supported API versions.

Podero follows Semantic Versioning e.g 0.1.0:

Given a version number MAJOR.MINOR.PATCH, we increment:

  1. MAJOR version when incompatible API changes are made
  2. MINOR version when functionality is added in a backward-compatible manner
  3. PATCH version when backward-compatible bug fixes are made

The developer documentation is tagged with the corresponding version number. The API URL is tagged with the current MAJOR.MINOR version.

Environments

You can access multiple environments within our systems. Each has its unique access policies and live/mocked configurations.

These environments are self-contained and isolated. Client credentials are associated with a specific environment and cannot be employed in other environments.

Production

Name URL
API https://app.podero.com/api/partners/v2.0/
Documentation https://app.podero.com/api/partners/v2.0/docs
OAuth Authorization Client Credentials

Sandbox

Name URL
API https://sandbox-app.podero.com/api/partners/v2.0/
Documentation https://sandbox-app.podero.com/api/partners/v2.0/docs
OAuth Authorization Client Credentials

Getting Started

To get started, please refer to the guide below. It will lead you through each step of authenticating with the API via Client Credentials, adding your first end-user, and adding a device. Additionally, we have attached some user journeys with typical use cases on how the API is commonly used with our Partners.

Getting Started

User Journeys

Server-to-Server Authentication

For server-to-server communication, this API uses the OAuth2 Client Credentials flow. Please feel free to contact your account manager to receive your initial admin username and password. You can log in at https://app.podero.com/accounts/login/ (or use your sandbox URL subdomain). Please make sure you change your password after your first login.

Register a new Application

Visit https://app.podero.com/oauth2/applications/register/ (or use your sandbox URL subdomain), to create a new client application. Immediately copy the client id and the client secret and keep them somewhere safe. You will not be able to retrieve your client secret later.