{"id":6847,"date":"2026-04-07T16:35:52","date_gmt":"2026-04-07T09:35:52","guid":{"rendered":"https:\/\/aisupport.skybizglobal.com\/skybizclouderp\/?p=6847"},"modified":"2026-05-20T13:13:21","modified_gmt":"2026-05-20T06:13:21","slug":"apisetup_advanced","status":"publish","type":"post","link":"https:\/\/aisupport.skybizglobal.com\/skybizclouderp\/apisetup_advanced\/","title":{"rendered":"SKYBIZ API Setup – Advanced"},"content":{"rendered":"

For standard guidance to setup the SKYBIZ API, you can refer: SKYBIZ API Setup – Standard<\/a><\/p>\n

Introduction to SKYBIZ API Setup\u00a0<\/strong><\/h4>\n
\n
\n

The SKYBIZ API is a secure, server-side REST interface that enables third-party applications, integration partners, and internal development teams to programmatically access and submit business data stored within the SKYBIZ system. Built on standard HTTP with JSON-formatted responses, the API provides structured, real-time access to five core business modules \u2014 Customer, Supplier, Item, Sales, and Purchase \u2014 allowing external systems to read and create SKYBIZ data without manual exports, file transfers, or direct database access.<\/p>\n

Every request is authenticated using a unique API Key and Secret pair generated and managed through the SKYBIZ portal. The Secret is hashed at rest using bcrypt and is never returned in any API response after initial registration, meaning credentials are protected even if a response is intercepted.<\/p>\n

Access is further controlled through a per-module permission system, where each credential set carries individually configured read and create permissions. The API enforces HTTPS in Production mode, applies a two-tier rate limit at both IP and API Key level to prevent abuse, and maintains a full audit log of every authenticated request. All of this is reviewable from the SKYBIZ portal under Active API Sessions.<\/p>\n

API Integration operates in one of three configurable modes \u2014 Disabled, Production, and Developer \u2014 each with different access controls suited to different stages of development and deployment. The API is designed for developers experienced with REST interfaces and JSON, and is intended to serve as a reliable, secure, and auditable bridge between SKYBIZ and any external system that needs access to your live business data.<\/p>\n<\/div>\n<\/div>\n

\"\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

\n

Getting Started<\/strong><\/h4>\n
Prerequisites<\/h5>\n

Before initiating any API interaction, the following conditions must be satisfied:<\/p>\n

 <\/p>\n

1. API Integration Mode.<\/strong> API Integration must be set to an active mode by your SKYBIZ administrator via the portal. If API Integration is set to Disabled (Mode 0), all incoming requests \u2014 including credential registration \u2014 will be automatically rejected. Ensure an active mode is configured prior to proceeding. See Integration Modes for a full description of each mode.<\/p>\n

\"\"<\/a><\/p>\n

 <\/p>\n

2. Callback URL Availability.<\/strong> A valid and accessible Callback URL is required. The Callback URL must be publicly accessible, fully operational at the time of credential registration, and capable of receiving POST requests. The credential issuance process is dependent on the successful delivery of data to this endpoint.<\/p>\n

\"\"<\/a><\/p>\n

<\/h5>\n
Integration Mode<\/h5>\n

The SKYBIZ API operates in one of three modes, controlled by the SKYBIZ administrator. The mode governs security requirements and origin restrictions for all API requests made under that store’s credentials.<\/p>\n\n\n\n\n\n\n\n
Mode<\/th>\nName<\/th>\nBehaviour<\/th>\n<\/tr>\n<\/thead>\n
0<\/td>\nDisabled<\/td>\nAll API requests rejected with 403. No data access or registration is possible.<\/td>\n<\/tr>\n
1<\/td>\nProduction<\/td>\nHTTPS is required for all API calls. Any request origin is permitted.<\/td>\n<\/tr>\n
2<\/td>\nDeveloper<\/td>\nLocalhost origins only (e.g. http:\/\/localhost, http:\/\/127.0.0.1 and common ports). HTTP is permitted for local testing.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

The active mode is returned in every successful data response as the mode<\/code> field, so your integration can verify the mode under which a request was processed.<\/p>\n

If a request violates the mode’s rules \u2014 for example, a plain HTTP request under Production mode \u2014 the API returns 403 Forbidden. Contact your SKYBIZ administrator to change the integration mode.<\/p>\n

Credential Registration Workflow<\/h5>\n

The credential registration process consists of the following steps:<\/p>\n

Step 1 :<\/strong> Submit a registration request<\/strong><\/p>\n

Initiate the process by sending a POST request<\/strong> to the registration endpoint with the following parameters:<\/p>\n