Before invoking the Arcadia Enterprise Data API, you must first enable it in the configuration file of the Arcadia Web Server, and obtain an API key.
This article includes the following topics:
After completing these tasks, proceed with using the Data API interface; see Example of Data API Usage.
To enable Arcadia Enterprise Data API, update the ArcViz configuration settings, and restart the ArcViz instance.
Follow these steps to enable Data API:
Depending on your installation, edit the following settings:
On the Cloudera Manager interface, enter the settings in the Arcadia Visualization Server Advanced Configuration Snippet (Safety Valve) for settings_cm.py field.
On the Ambari interface, enter the settings in the ArcViz Settings field.
For MapR, enter the settings directly in the
settings.py file.
Add the ENABLE_API_KEYS and DATA_API_ENABLED settings
in the configuration file of the Arcadia Web Server:
ENABLE_API_KEYS = True
DATA_API_ENABLED = TrueIn situations where users do not login directly into the visual layer of Arcadia Enterprise, you must obtain an API key, and implement it when using DATA APIs.
Follow these steps to obtain API keys:
After obtaining an API Key, you can use it to authenticate the user to access the dataset, and invoke the data layer of Arcadia Enterprise at the following endpoint:
http://server:port/arc/api/data