Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Overview
API Reference Overview
How to use the API 'Try It' feature
Apps And Solutions
Health
Application
Solution
Common
Authentication
Download OpenAPI file
Authentication And Authorization (AAA) Service
Role Management
User Management
Authentication
Connection Management
Group Management
File Management Service
Folders
Files
SDS Service
App
Vault
Data
Messaging Service
Introduction
Messages
Service Provider Management
Templates Management
Metering
Tenant Config Management
Notification Management
Mobile Push Notifications
App
App Notification
Event
Notification
Dispatch Service
Job Type
Job Workflow
Job
Job - Config
Dispatch Type
Dispatch
Mobile APIs
Dispatch - Config
Ledger
Ledger in batch
Custom Code Config
Participant Service
Tenant
Participant Type
Participant Type - Custom Code Config
Participant Type - Attributes Config
Participant Type - State Machine
Participant
Templates
Participant State
Participant - Batch Processing
Onboard
Container Service
Container Type
Container Type - Custom Code Config
Container Type - Attributes Config
Container Type - State Machine Config
Container
Container State
Container Group
Container - Batch Processing
Workflow Service
Execution Task
Changelog
Execution Macro
Execution Workflow
Execution Workflow Instance
Health Check
State Machine Service
State Machine Config
Entity
Events
Reasons
Instance State
Default Plugins
Job Manager
Work Order Manager
Container Manager
Workflow Manager
Cancellation Manager
Movement Tracking Service
Trace Data
Missing Sequence Numbers
Snapped Distance
Map Service Provider Management
Maps
ETA
Route
IOT Device
Geofence
MTS Subscription
Consent
Track
GPS Integration
MTS Metering
Settings
Events
Entity Service
Entity Type
State Machine Config
Entity Instance
Entity Type - Custom Code Config
Entity Instance State
Templates
Entity - Batch Processing
Onboard
Location Service
Location
Country
State
City
Search
Order Service
Order Config
Order State Machine Configuration
Order State Machine Transition
Work Order State Machine Configuration
Work Order State Transition
Order
Batch Order
Custom Code Config
Plugin Callback
External Reference APIs
Work Order Config
Work Order Status
Plugins
PluginWorkflow
User FPA
Users
File Upload
Designation
Groups
Config Management
Teams FPA
Teams
Filter API
Facility FPA
Facilities
Vehicle FPA
Vehicles
LogisticsOrder API
Order
Client Order APIs
Batch Order
Callback APIs
Tenant Init
AAA - External Authorizer
Authorization
Orchestrator
Plugins
PluginsV2
PluginWorkflow
Rules
RulesV2
DLQ Service
Query & Listing
Scheduler Service
Scheduler Service
Webhook Service
Apps
Events
Subscriptions
Attribute Alias API
POST
Create type with attribute aliases
PUT
Update type with attribute aliases
GET
Get all attribute aliases
Docs powered by Archbee
Apps And Solutions
Application

Register an Application

1min
POST
/developer/apps
Registers an application given all fields are valid and provided API key has authorization to the organization and team.
Header Parameters
x-developerplatform-role
string
x-developerplatform-access
string
Query Parameters
organizationId
string
*
teamId
string
*
Body Parameters
body
RegisterApplicationRequestDto
*
displayName
string
*
type
string<WEB | BACKEND | MOBILE>
*
listingId
string
*
version
string
*
isConsoleCompatible
boolean
*
visibility
object
All Of
ApplicationVisibilityDto +
url
object
All Of
ApplicationUrls +
shortDescription
string
*
longDescription
string
categories
string[]
*
menu
MenuItemDto[]
*
packageName
string
Responses
201
RegisterApplicationResponseDto
id
object
*
All Of
ApplicationVersionIdentifierDTO +
400
Bad Request
BadRequestErrorResponseDTO
error
BadRequestErrorDTO
*
request
StandardRequestDTO
*
404
Org or Team not found
NotFoundErrorResponseDTO
error
NotFoundErrorDTO
*
request
StandardRequestDTO
*




Updated 11 Jun 2024
Did this page help you?
PREVIOUS
Health Check
NEXT
Get Application By Listing ID
Docs powered by Archbee