Application API

When integrating Netify into a user interface (UI), it is often necessary to present the end user with application information. Integrator API endpoints are available to fetch Netify's application list, categories, changelog, and hierarchy as JSON objects.

The API returns JSON objects containing IDs, tags, human-friendly labels, categories, and logos. Integrators commonly cache the application catalog and changelog locally and refresh periodically to reduce API requests and improve UI responsiveness.

Quick Links - Integration APIs

Endpoint Summary

The following endpoints provide information on the applications supported by the Netify Agent:

Data	Description
Application Catalog	The list of supported applications.
Application Categories	The list of categories used by applications.
Application Changelog	The log of application additions, deletions, and signature changes.
Application Hierarchy	The application hierarchy.

Authentication

To access these endpoints, an API key must be passed in the x-api-key parameter in the request headers. Please contact us for details about acquiring an API key.

Response Codes and Format

Standard HTTP response codes are sent by the API, along with the following status attributes (if available):

status_code: a status code number
status_message: a human-readable status message
status_fields: an array of validation errors (if any)

Response Payload - Status Information

{
   "status_code": 0,
   "status_message": "Success.",
   "data": ...
}

Additionally, the API sends standard HTTP response codes.

Code	Response	Description
200	OK	Request was successful
400	Bad Request	The client request was invalid
401	Unauthorized	The API key or credentials were invalid
403	Forbidden	The API key or credentials were valid, but access was not permitted
404	Not Found	The resource was not found
405	Method Not Allowed	The method is not supported by the API
409	Conflict	Resource already exists
422	Validation Error	Parameters sent in the request were invalid
429	Too Many Requests	Too many requests were sent to the server
500	Server Error	Server-side error (rare)

Application Catalog Endpoint

GET

https://agents.netify.ai/api/v2/integrator/applications/catalog

Returns the list of all applications - past and present - supported by the Netify Agent.

Application Attributes

id

integer

The ID number associated with the application.

tag

string

The tag associated with the application (for example, netify.whatsapp).

label

string

The name an end user would typically use to identify the application.

full_label

string

A more formal full name of the application, if available.

description

string

A brief summary of the application.

home_page

object

A small object that defines both the url and associated text for the application home page.

active

boolean

Indicates whether the application is currently supported.

favicon / icon / logo

string

The URLs for application branding image assets.

favicon_source / icon_source / logo_source

string

The data source used for each branding image asset.

Application Object - JSON Example

{
    "id": 142,
    "tag": "netify.whatsapp",
    "label": "WhatsApp",
    "full_label": "WhatsApp Messenger",
    "description": "WhatsApp allows users...",
    "home_page": {
      "url": "https://www.whatsapp.com",
      "text": "WhatsApp"
    },
    "category": {
      "id": 17,
      "tag": "messaging",
      "label": "Messaging"
    },
    "active": true,
    "favicon": "https://static.netify.ai...",
    "icon": "https://static.netify.ai...",
    "logo": "https://static.netify.ai...",
    "favicon_source": "app",
    "icon_source": "app",
    "logo_source": "app"
}

Application Categories Endpoint

GET

https://agents.netify.ai/api/v2/integrator/applications/categories

Returns the list of application categories.

Application Category Attributes

id

integer

The application category ID.

tag

string

The application category tag.

label

string

The category label.

Application Category - JSON Example

{
    "id": 3,
    "tag": "advertiser",
    "label": "Advertiser"
},
{
    "id": 4,
    "tag": "entertainment",
    "label": "Arts and Entertainment"
},
...

Application Changelog Endpoint

GET

https://agents.netify.ai/api/v2/integrator/applications/changelog

Returns the application changelog with additions, deletions, and changes in chronological order.

Application Hierarchy Endpoint

GET

https://agents.netify.ai/api/v2/integrator/applications/hierarchy

Returns the application hierarchy with parent/child relationships.

The returned data lists parent application objects with a children attribute containing child applications. For example, the Google application includes child applications like Gmail, Google Maps, and YouTube. A visualization is available here.

The hierarchy is restricted to a maximum of three levels:

First Level - Tencent Games: a very large gaming division
Second Level - Supercell: a subsidiary of Tencent Games and publisher of many games
Third Level - Clash Royale: one of the games published by Supercell

The hierarchy is provided to help guide decisions on user interfaces (UI) and user experience (UX). This data is not directly used by the Netify Agent.