EVRYTHNG Developer Hub

Welcome! Here's where you'll find what you need to start working with EVRYTHNG as quickly as possible. There are comprehensive guides, documentation, and support if you get stuck. We encourage you to dive in and explore.

Create Free Account Read Documentation

Here is a list of terms you may come across while using the EVRYTHNG Platform and browsing this documentation.

For a more general look at the Platform you may also be interested in the API Overview page.

Term
Definition
Read more

Account

The first resource encountered in the Platform is an account, which is created when you sign up with EVRYTHNG for a free account.

This is needed for you to login to the Dashboard and send requests to our API. All the resources (Thngs, products, applications) you create are stored and linked in your account.

Each account has a unique Operator API key.

Action

An action is an event sent to the Platform on behalf of a user in an application on a Thng or product, at a given place and time.

For example, when a product is scanned or an 'on' command is sent to a device.

Actions can be used to record the activity of users within applications.

Action Type

An Operator can define action types for an account.

When defining these action types, it's possible to add specific custom fields in order to customize these actions on the Dashboard.

ADI

An ADI is a permanent and globally unique cloud resource that holds information about a physical object or thing in the form of dynamic and static attributes.

For example, an ADI may encompass a unique Thng, and all it's attributes, properties, and history.

API Keys

A string that allows authenticated access to the Platform and its features through the REST API. There are five kinds of API keys:

  • Operator key
  • Application key
  • Application User key
  • Trusted Application key
  • Device key

Application

An application represents a web or native client that interacts with the EVRYTHNG Platform.

Developers can create multiple applications inside their projects.

Application User

These are the end users of your applications. Applications can create Application Users that are unique to each application.

Unlike Operators, Application Users have no direct access to the EVRYTHNG API or Dashboard.

Batches

A batch allows creation of a large numbers of Thngs in the Platform.

Collection

A collection is a group of Thngs (or a group of other collections). Collections can be created by various users, and the same Thng can be in more than one collection.

Custom fields

Custom fields are developer-defined attributes of a resource, stored in the customFields field.

They can be used to enhance the metadata of say, a Thng to incorporate your own vision of a Thng (e.g. colour, size, etc.)

Dashboard

The EVRYTHNG Dashboard is the web interface manipulation of your account and all resources that belong to it.

You can visit it here: dashboard.evrythng.com

Device

A device is a web-connected Thng. For example, a smart plug socket (as opposed to a Thng which is identified with a 2D printed code).

Enterprise Users

Some features are only available with an enterprise subscription. Please get in touch to discuss enabling them on your account.

Filter

Most API end-points support filtering to retrieve or edit only a subset of resources that match certain criteria.

Jobs

The Jobs API allows the Platform to execute asynchronous long running jobs, creating or updating many resources. For example, applying an action to a group of Thngs.

Location

Locations are of pre-defined type of property for a Thng that stores snapshots of their geographic position over time. A location is stored as a geographic coordinate in GeoJSON format.

Operator

Operators interact with the Platform via the Dashboard or the REST API and supporting SDKs.

They can be assigned access to create, manage and read Thngs, products, projects applications, roles and Application Users.

An Operator can be invited to join other accounts.

Permissions

There is a set of permissions attached to each API key. These permissions allow the API to decide if the request is allowed to proceed or not.

Places

Places are resources corresponding to a place in the real-world. For example a specific geographic position or an abstract place like an address. A place is used to pinpoint an action with a product or Thng.

Product

A product is a class of objects - SKU-level (Stock-Keeping Unit) information, such as the name, description, URL, images for that product, and other characteristics that all instances of that product share (size, weight, price, etc.). A Thng can be linked to a product to indicate its class-inherited characteristics.

Project

Every account may contain one or more projects. A project is a container for applications and Application Users, and provides an easy way to share and work with a subset of the resources that exist in an account.

Property

Thngs and products can have many properties, which can be strings, numbers, arrays or objects. Unlike custom fields, changes to properties are timestamped, which allows you to track them over time and view their value history.

Reactor

The Reactor lets the Platform react to an action or a property change using custom business logic rules.

For example triggering a Slack alert when a property reaches a certain threshold, or updating SAP when an action is performed.

Redirector

Not to be confused with Reactor, the Redirector allows developers to set up a redirect for scanned URL/QR code based on rules such as time of day or location.

For example, a URL (which could easily be encoded in a QR code) could redirect the user based on the day of the week.

Resource

A general term to refer to all the data types and objects stored in the platform. For example Thngs, collections, products, places, actions are all considered resources.

Access Role

An access role is a permission template that can be assigned to an Application User or group of users.

Identifier Recognition (previously known as SCANTHNG)

Lets you identify EVRYTHNG products and Thngs directly from any web or native application. It allows a user to take a picture of an object, a QR code, or a barcode and recognize it as an EVRYTHNG product or Thng.

Scope

Scope defines by whom resources can be seen - in a specific account or project, or by a specific Application User.

What you can then do with those resources is governed by permissions of the key used to make any given request.

Short Domain

Short domains are used for redirections.

By default, http://tn.gg is used, but enterprise customers can chose their own domain.

Short ID

Every resource has a globally unique, automatically-generated identifier (e.g. UYef7Xs7tF39QhR4CAApXhgq)

In addition, for redirection purposes a shorter ID may be used. e.g. 7Bk9E6Rc.

These are unique for a given short domain, but not in themselves globally unique.

Short URL

A short URL is the combination of a short domain and a short URL.

This allows individual Thngs and products in the EVRYTHNG platform to be redirected to a web application.

e.g. http://tn.gg/7Bk9E6Rc

Task

A task is an asynchronous operation that can be performed on a batch, such as creating new Thngs or updating existing ones.

Thng

Thngs are unique instances of products. e.g. the smart plug in your living room, the t-shirt you are wearing, or the can of soda you are drinking.

A Thng acts as digital container for a physical product.

Pub/Sub Broker (previously known as THNGPUSH)

In addition to our standard scalable REST API, we also provide a multi-protocol publish/subscribe M2M broker where applications and devices can push and receive notifications (property updates, actions created, etc.) from the Platform.

THNGHUB

THNGHUB is a Local Cloud Gateway to the EVRYTHNG platform.

It is a lightweight modular software application that lets you integrate non-IP protocols to the Web and allows local control of connected products.

User

See: Application User above

Glossary