{"version":1,"pages":[{"id":"IMY8avA3dCFwEaaUAciP","title":"API Introduction","pathname":"/","siteSpaceId":"sitesp_gbf8B","description":"AlphaX Cloud's API codenamed Conduit, is our modern API designed to seamlessly transport data from the edge into the enterprise for downstream consumption."},{"id":"bHqRgqyIDOODerbYA9xs","title":"General Architecture","pathname":"/general-architecture","siteSpaceId":"sitesp_gbf8B","description":"AlphaX splits its services into 2 general components, Data In and Data Out, these are sometimes referred to as upstream and downstream."},{"id":"tygeEL306bhwTIaTIHNN","title":"Authentication","pathname":"/authentication","siteSpaceId":"sitesp_gbf8B","description":"The Conduit feature enhances data import/export security via a token and server-side validation, activated individually for users, allowing token-authenticated access to user-specific data."},{"id":"d6dqIBL1wtJgMFLKnS9K","title":"Rate Limits","pathname":"/rate-limits","siteSpaceId":"sitesp_gbf8B","description":"The conduit API service is throttled by default."},{"id":"bDJnxnMJVnau2RzzEGP5","title":"HTTP","pathname":"/http","siteSpaceId":"sitesp_gbf8B","description":"Using the HTTP API in AlphaX is a relatively simple process. The user must format his/her data in the correct format and simply use the method of choice to send and receive data from the provided URL."},{"id":"n6vlhzp4uLVmSmukTLnX","title":"HTTP Headers","pathname":"/http/http-headers","siteSpaceId":"sitesp_gbf8B","description":"AlphaX conduit service utilizes specific HTTP headers for authentication, data format specification, compression, and method override within requests and responses.","breadcrumbs":[{"label":"HTTP"}]},{"id":"zTnTMX4Paa0Ou2T1rmtl","title":"HTTP Parameters","pathname":"/http/http-parameters","siteSpaceId":"sitesp_gbf8B","description":"API Resource requests commonly result in a response containing the current representation of one or more resources.","breadcrumbs":[{"label":"HTTP"}]},{"id":"nFgFA2zh1arfSPw9Y9Ho","title":"HTTP Compression","pathname":"/http/http-compression","siteSpaceId":"sitesp_gbf8B","description":"HTTP compression is supported on both incoming and outgoing requests.","breadcrumbs":[{"label":"HTTP"}]},{"id":"DgLNIFu96JzrKznu6TVr","title":"HTTP Error and Status Codes","pathname":"/http/http-error-and-status-codes","siteSpaceId":"sitesp_gbf8B","description":"The Conduit service will return appropriate HTTP status codes for every request.","breadcrumbs":[{"label":"HTTP"}]},{"id":"UcThcQELcJVA2rNwbNNf","title":"SSL Requests","pathname":"/http/ssl-requests","siteSpaceId":"sitesp_gbf8B","description":"All conduit API requests must be made over HTTPS","breadcrumbs":[{"label":"HTTP"}]},{"id":"e9FoCPthGDxWXxen0GlA","title":"Sending Data","pathname":"/http/sending-data","siteSpaceId":"sitesp_gbf8B","description":"How to identify the correct uplink data format and prepare your data for uplink into the AlphaX system.","breadcrumbs":[{"label":"HTTP"}]},{"id":"FAgLiDJWJRGRKYNjzOEj","title":"Uplink Data Format V1","pathname":"/http/sending-data/uplink-data-format-v1","siteSpaceId":"sitesp_gbf8B","description":"Data format V1 allows users to compress their payload and retain the convenience of JSON readable header information for reduced size and performance.","breadcrumbs":[{"label":"HTTP"},{"label":"Sending Data"}]},{"id":"4EEHhW6R8Wu6FzD83B38","title":"Uplink Data Format V2","pathname":"/http/sending-data/uplink-data-format-v2","siteSpaceId":"sitesp_gbf8B","description":"AlphaX API expects JSON with token, networkId, timestamp, and data array containing channelId and value. Supports advanced data integration and security features.","breadcrumbs":[{"label":"HTTP"},{"label":"Sending Data"}]},{"id":"ybMDgO4NTFsfiI1MBlUW","title":"Retrieve Data","pathname":"/http/retrieve-data","siteSpaceId":"sitesp_gbf8B","breadcrumbs":[{"label":"HTTP"}]},{"id":"hDNwmvcFniQdvEwkWevW","title":"Conduit V4","pathname":"/http/retrieve-data/conduit-v4","siteSpaceId":"sitesp_gbf8B","description":"Conduit V4 provides a minimal set of data, best used for applications that require values for updates where device data is already known.","breadcrumbs":[{"label":"HTTP"},{"label":"Retrieve Data"}]},{"id":"EYAE5Ty9jkZkGca0XIw7","title":"Conduit V6","pathname":"/http/retrieve-data/conduit-v6","siteSpaceId":"sitesp_gbf8B","description":"Conduit V6 provides a full set of device data for each data point requested. Best used to register devices and update devices in other systems.","breadcrumbs":[{"label":"HTTP"},{"label":"Retrieve Data"}]},{"id":"P6AmeHGLykILFkKsTI8m","title":"Conduit V7","pathname":"/http/retrieve-data/conduit-v7","siteSpaceId":"sitesp_gbf8B","description":"This guide provides detailed support for the API endpoint that supports multi-stage aggregations for time series data.","breadcrumbs":[{"label":"HTTP"},{"label":"Retrieve Data"}]},{"id":"0LCaXxghRWpUNi19Ysfd","title":"Using Conduit V7","pathname":"/http/retrieve-data/conduit-v7/using-conduit-v7","siteSpaceId":"sitesp_gbf8B","description":"API Parameters When timerange Applied and Valid, return the data from last timerange seconds. When timerange Not Applied or Invalid and fcdt & tcdt Applied and Valid, return the data from fcdtto tcdt.","breadcrumbs":[{"label":"HTTP"},{"label":"Retrieve Data"},{"label":"Conduit V7"}]},{"id":"DPvxZRchj1A1D8DStZrs","title":"Aggregation Features (Optional)","pathname":"/http/retrieve-data/conduit-v7/aggregation-features-optional","siteSpaceId":"sitesp_gbf8B","description":"Aggregations are used to transform the data before loading into a downstream application. It can be useful to reduce the amount of data transfer and apply simple calculations on the fly.","breadcrumbs":[{"label":"HTTP"},{"label":"Retrieve Data"},{"label":"Conduit V7"}]},{"id":"WUYRkPZ6gpiVG6b7pgv1","title":"Common Issues & Troubleshooting","pathname":"/http/retrieve-data/conduit-v7/common-issues-and-troubleshooting","siteSpaceId":"sitesp_gbf8B","description":"The ConduitV7 API is complicated. Below are some common issues and troubleshooting tips to help you solve problems you may encounter while using the ConduitV7 API.","breadcrumbs":[{"label":"HTTP"},{"label":"Retrieve Data"},{"label":"Conduit V7"}]},{"id":"rl6mfnAp9O40UOy40bN1","title":"Usage Examples","pathname":"/http/retrieve-data/conduit-v7/usage-examples","siteSpaceId":"sitesp_gbf8B","description":"These examples provide a starting point and can be modified based on your specific requirements. Always ensure that you are using the correct parameters and their values for successful data retrieval","breadcrumbs":[{"label":"HTTP"},{"label":"Retrieve Data"},{"label":"Conduit V7"}]},{"id":"WY0M4zwokzLWCDZd1x8M","title":"MQTT","pathname":"/mqtt","siteSpaceId":"sitesp_gbf8B","description":"MQTT is a lightweight IoT protocol useful for connections with remote locations where a small code footprint is required."},{"id":"S2a0JdMC67tu6OhktM6f","title":"MQTT Authentication","pathname":"/mqtt/mqtt-authentication","siteSpaceId":"sitesp_gbf8B","breadcrumbs":[{"label":"MQTT"}]},{"id":"nm3GDLWzLFiwkq7RAk9c","title":"MQTT Broker Address","pathname":"/mqtt/mqtt-broker-address","siteSpaceId":"sitesp_gbf8B","description":"Connect to the MQTT broker using the following addresses.","breadcrumbs":[{"label":"MQTT"}]},{"id":"R1DebZLyN0EKZdfXx7Zf","title":"Publishing Data","pathname":"/mqtt/publishing-data","siteSpaceId":"sitesp_gbf8B","breadcrumbs":[{"label":"MQTT"}]},{"id":"qa3K1BQFOMmRnjtp4cf4","title":"MQTT Publish Format V1","pathname":"/mqtt/publishing-data/mqtt-publish-format-v1","siteSpaceId":"sitesp_gbf8B","description":"MQTT Publish format V1 is the compressed format, useful for data constrained devices. Data remains in byte array and decoded in AlphaX cloud.","breadcrumbs":[{"label":"MQTT"},{"label":"Publishing Data"}]},{"id":"WEFICV4RO3duqvPgmdis","title":"MQTT Publish Format V2","pathname":"/mqtt/publishing-data/mqtt-publish-format-v2","siteSpaceId":"sitesp_gbf8B","description":"MQTT Publish format V2 is a user friendly, human readable JSON package for sending data to a device on AlphaX Cloud.","breadcrumbs":[{"label":"MQTT"},{"label":"Publishing Data"}]}]}