👍 Best practices & FAQ¶
There are a number of best practices for use to make the most of the Reincubate Cloud Data API.
- Make use of this documentation. Many of the common questions are answered in these materials, and the documentation is regularly updated.
- The API status page can be used to sign up for updates on any planned or emergency API maintenance.
- Clients that take advantage of a Slack integration channel tend to go live sooner. Check out how to request on under API support and status.
- The Open Source client provides a full example of an integration with the ricloud service, and examining that (or re-using code from it) can save a lot of work during the integration.
- Take advantage of the mock data when testing and integration, but bear in mind that real data access can be slower.
- Follow security and privacy best practice, and do not store end-user credentials. Instead, use the tokenisation system.
- Don’t hard-code the task submission or results endpoints in requests: whilst they may often take the same value, the API may vary them from time to time.
- Don’t generate more tasks than are necessary: for instance, polling for backup updates is unnecessary more than a few times per day, and a lot can be done to devise an accurate schedule for this. The API is capable of completing a large number of tasks and generating a lot of data in a small amount of time, and in particular when using aschannel, clients should be wary of requesting more than they can readily consume.
- Reincubate considers it a best practice to directly contact account holders at such times as their accounts are first accessed, and then on an ongoing basis to ensure that they are informed client activity. See enhancing privacy for more details.
- Clients with requirements to regularly poll accounts should evaluate asmaster rather than asapi.
Does the API store any feed or file data?¶
No, not when used with aschannel, as feed and file data is streamed to clients and not persisted in the RI stack. When using asstore, information is stored in buckets until retrieved. However, the channel is recommended for almost all use-cases.
In some cases the API will persist some metadata, most notably where asmaster‘s scheduler retains a rolling window of metadata to help it calculating accurate polling windows.
How do I request feeds and attachments with asmaster?¶
There is no need to. Once subscribed to accounts or devices, data will be provided automatically via aschannel as and when it is ready.
How do I tell asmaster to give me more or fewer modules?¶
There is no need to do anything programmatically. A client’s key configuration includes data on which modules they have access to, and all modules will be used when streaming data. Once the provisioning team have updated a client key, the new module-set will be reflected in feeds.
What frequency does asmaster poll with?¶
asmaster‘s scheduler mechanism strives provide data subject to two aims: not exceed the best-practice polling frequency for a given service, and providing data as close to when it is made available as possible. The scheduler will always prioritise not harming the account or violating best-practice over getting fresh data.
When operating with real-time data, this can mean data is provided with real-time, near-time or batch frequency. With batch data, the scheduler will itself work in batch mode.
The ruleset behind frequency selection is dynamic.
What limits are set on a trial key?¶
Trial key limits can vary according to the nature of the key. They may be limited by:
- Number of devices or accounts accessible via the key
- Support for non-2FA/2SV accounts (eg. trial users can be prevented from accessing non-2FA accounts for compliance reasons)