Access Station

Access Station Micro Connectivity requirementsAccess Station Micro UtilityAccess Station Micro DatasheetAccess Station Micro Quick Start GuideAccess Station Micro Supported Countries, Safety & Certification informationAccess Station Micro Product ManualAccess Station Micro Ethernet connectivityAccess Station Micro Sealing cover ManualAccess Station Micro troubleshooting

API

API documentationAPI versioningAPI credential creationAPI credentials renewalAPI rate limitingAPI Response code referencesGlobal Coverage APITimestamps format in API

Callbacks

Principles

Getting StartedCallback and ConnectorsCallback mediumCallback integrationCustom callback creationEvent callback creationPartner Callback creation

Data callback

UplinkBidir

Service callback

StatusAcknowledgeRepeaterData advanced

Error callback

Error callback

Event callback

Event typeBreak in message sequenceOff contractOut of message sequenceOn contractReceive first test messageReceive first payable messageRenewalSuspendResumeReplaced toInvalid private keyChange device typeReplaced byIntra transferExtra transferRestartOverusageContract switch

Partner built-in callback

AWS IoT built-in callbackAWS Kinesis built-in callbackIBM Watson IoT Platform built-in callbackMicrosoft Azure Event hub built-in callbackMicrosoft Azure IoT hub built-in callbackUnaConnect built-in callback

Callback troubleshooting

Callback error logCallback troubleshooting procedure

Backend user access management

Backend user creation: invitationBackend user timezoneDeleting users from a groupBackend user rolesBackend user account creationBackend user role modificationPage forbiddenReset Backend User password

Certification

Sigfox Certifications

Sigfox Certification HandbookChecklist for device based on another Sigfox Ready device -similarity-

Sigfox Radiated Performance tests

Be prepared for Radiated Performance TestsSigfox Radiated Performance Test Specifications v2.0

Sigfox RF & Protocol tests

Be prepared for Sigfox RF & Protocol Tests v5.0.2Sigfox RF & Protocol Test Specification v5.0.3Sigfox RF & Protocol Test Procedure

Device HW

Device Current Drain : Downlink optimizationAntenna Design for Sigfox Ready devicesSens’it antennaOscillator Technical NoteBattery Application Note

Device management

Device Type

Device type: meaningCreate a new device typeContractsPayload display parameterSet a keep alive delayCommunication status indicator

Principles

Radio ConfigurationSequence number: general knowledgeSequence number: troubleshootingLink Quality: general knowledgeDownlink informationDownlink callbacks

Device

Register a deviceRegister a batch of devices in one goDevice ID/PAC coupleDevice and Token lifecycleMove a deviceSuspend & ResumeUnsubscribe a deviceStop a Sigfox subscription and billingSubscription automatic renewalDevice not communicatingDeleting DevicesRestart a device subscriptionEnd product certificateEdit multiple devices simultaneouslyReplace a deviceDevices being transferredBulk operationsExport a list of devicesOut Of Band (OOB) messagesOff-contract deviceDevice messages delayRegister as a prototypeSet device location

Helpful

GLOSSARY

Industrialisation

Sigfox Credential provisioning for Open Software Architecture modules and SDKHow to test in production ?How to get Sigfox Credential from CRA ?

Products & Services

UnaConnectTest messages: Contract optionBackend user helpbook

Coverage

Display the Sigfox global coverageDisplay the Sigfox Monarch global coverageSigfox coverage maps .kmz filesSigfox Service map

Atlas Service

Actual device position outside of location radiusAtlas service callback creationNetwork location: service not availableLarge location radiusNetwork Location position moving over timeProvided location far from actual locationMessage location accuracyNo location provided for a messageLocations over seaAtlas service: Micro stations geographical coordinates

UnaBiz Ready-to-Use Products

UnaMKRUnaMKR (Mini)UnaBell LTE-MUnaReaderUnaSensorsUnaShield

Other

Sigfox Partner NetworkSigfox support portal login issuesTicketing tool login

SDR Dongle

Sigfox SDR dongle datasheetWhat is the public key and how to activate it?

Sigfox Network Emulator

Sigfox Network Emulator - User GuideSigfox Ready™ modules compatibilitySigfox Network Emulator - troubleshooting

Radio Signal Analyzer

Radio Signal Analyzer - User guide

Sens'it

Sens'it v3 datasheetSens'it v2 user guidesSens'it v3 user guideHow to use Sens'it after closure of sensit.io applicationSens'it Device all you need to knowSens'it for Sigfox learnings
API

API documentation

The Sigfox API documentation is available publicly or can be obtained through a dedicated endpoint.

Public version

The public API documentation is based on standard permissions (i.e. Device Manager W). To browse this documentation please go to https://support.sigfox.com/apidocs.

Permissions-tailored version

The full API documentation tailored according to the API user permissions can be retrieved as follows.

  1. Create an API User in the Sigfox backend, from the API Access page. The steps are described here: API credential creation.
  2. By using the following endpoints you can get the documentation in either JSON or YAML format:
    1. https://api.sigfox.com/v2/doc.json
    2. https://api.sigfox.com/v2/doc.yaml
  3. If you want to display human-readable API documentation, we advise using either ReDoc for the latest features or swagger editor for a quick online overview.

API V2 usage documentation:

Sigfox API Usage-rev3.2.pdf

API Response code references

API rate limiting

Can't find what you're looking for ?

Have questions? Our worldwide Community of expert fans can answer them.
Have answers? Join the Community and help!

slack logo

Ask the community >