FAQ
How can I get an API Key?
- Please contact us at Start a trial with SkyPath.
What base url to specify while initializing SkyPath Web SDK?
- Base url is an optional parameter. By default, it references to
api.skypath.io
, but in case you use proxy server for security purposes you may provide your own url.
What is flow?
- Flow is an abstraction that represents certain feature and provides standardized API to work with it. Usually, it follows certain steps and structure to keep the same interface for different features. Most of the flows have
start
,stop
,terminate
methods to control the running state andonData
,onError
,onIsProcessingChange
methods to subscribe for changes. They also haveupdateConfig
method to update configuration, but parameters may vary depending on the feature.
What authentication method should I use?
- Partner authentication (signed JWT method) is preferred for production use. It is more secure and provides more control over the data. Usage of API key directly is recommended only for testing and debugging purposes.