Develop Glossary

AltBeacon

The Open and Interoperable Proximity Beacon specification.

The AltBeacon specification defines the format of the advertisement message that Bluetooth Low Energy proximity beacons broadcast.

API Key

A unique identifier used to authenticate a user, developer, or calling program to our Application Programming Interface (API).

You can generate your own API keys in the Develop app.

Application Programming Interface

Abbreviation: API

A set of functions and procedures allowing the creation of applications that access the features or data of an operating system, application, or other service.

The main difference between how webhooks and APIs work is that, while APIs place calls without knowing whether they get any data update as a response or not, webhooks receive calls through HTTP POSTs from external systems only when those have some data updates.

Authentication Application Programming Interface

Abbreviation: authentication API

Authenticates external applications with Chargifi servers to enable customers to use all the Chargifi APIs.

The Chargifi authentication is based on the OAuth2 standard.

Bearer Token

A security and access token used with OAuth 2.0.

The bearer token is required to grant access to the bearer when authenticated. The token is a cryptic string, usually generated by the OAuth server in response to a login request.

Chargifi Library

An Android software development kit (SDK) that allows you to build customized experiences around wireless charging.

Chargifi Software Development Kit

Abbreviation: Chargifi SDK

A set of tools to allow you to create an integrated application for your own existing platform.

Chargifi SDKs are available for the following:

Android
iOS

Chargifi SDKs provide analytics and real-time data about network and human activity in your workplaces, hotels, and other venues.

Chargifi Swift Software Development Kit

Abbreviation: ChargifiKit

A Swift SDK that supports iOS 8+ and allows you to build customized experiences around wireless charging.

Chargifi Webhook

A smart integration solution that allows your existing application(s) to receive updates about wireless charging usage via push notifications from Chargifi Cloud.

Chargifi provides a range of custom HTTP callbacks to alert you to status changes in your Chargifi network.

Client ID

The client_id is a public identifier for apps. Even though it’s public, it’s best that it isn’t guessable by third parties, so many implementations use something like a 32-character hex string. It must also be unique across all clients that the authorization server handles.

Here are some examples of client IDs from services that support OAuth 2.0:

Foursquare: ZYDPLLBWSK3MVQJSIYHB1OR2JXCY0X2C5UJ2QAR2MAAIT5Q
Github: 6779ef20e75817b79602
Google: 292085223830.apps.googleusercontent.com
Instagram: f2a1ed52710d4533bde25be6da03b6e3

Client Secret

The client_secret is a secret known only to the application and the authorization server. It must be sufficiently random to not be guessable, which means you should avoid using common UUID libraries which often take into account the timestamp or MAC address of the server generating it. A great way to generate a secure secret is to use a cryptographically-secure library to generate a 256-bit value and converting it to a hexadecimal representation.

Hypertext Transfer Protocol POST Request

Abbreviation: HTTP POST request

A request method that is supported by HTTP used by the World Wide Web.

Chargifi webhooks use HTTP POST requests to push notifications to third party systems.

The body of our requests contains data regarding the status of Spots and events that trigger notifications.

Notification

Information that is pushed to another application about a change in the state of a Spot.

You can select the types of notifications you want pushed to your third-party software in the Manage Webhooks section of the Smart Integrations part of the Develop app.

OAuth

An open standard for access delegation.

We use OAuth 2.0 to permit information sharing with third party applications and platforms.

We issue access tokens to enable you to seamlessly integrate the Chargifi Platform with your own applications.

PHP: Hypertext Preprocessor

Abbreviation: PHP

An open-source server-scripting language that we use in our SDK to allow you to build a server-side service.

Chargifi PHP SDK interacts with the Chargifi REST APIs.

The PHP SDK abstracts many of the REST APIs for you and handles the OAuth2 authentication process as well.

Redirect URL

A web server function that sends a user from one URL to another.

You use URLs for redirecting your end users from your platform to the Chargifi Platform if you are implementing our APIs to integrate the platforms.

Smart Association

A setting an administrator can make for a venue in Chargifi Deploy app.

Anyone can charge their devices, but if users at the venue have a venue-specific app downloaded on their phone, then the wireless charging sessions can be associated with those users and the data used for analytics and business purposes.

Articles in this section