Getting Started with Demyst

This guide takes new Demyst users from signup through their first production deployment of external data. Data is deployed via Demyst Data APIs, which are easy-to-build HTTPS APIs that combine external data and customizable logic to power core applications and data workflows. Data APIs can also pull directly into a CRM or be applied in other workflows.
(For specific information about other data deployments, please contact our sales team.)

This guide covers 8 steps for creating a production Data API:

  1. Signing up and understanding the home page

  2. Finding a relevant product in Demyst’s Data Catalog

  3. Learning about recipes and finding relevant uses

  4. Creating and testing Data APIs by cloning dataset connectors and recipes

  5. Editing the configuration of a Data API

  6. Running a programmatic request against a Data API

  7. Moving a Data API from evaluation to production

  8. Reviewing transaction logs for a Data API and viewing reporting dashboards

Step 1: Signing up and understanding the home page

The Demyst Platform is accessible from our website:

  • Create an account for the Demyst platform by visiting our website and clicking the sign up button, going directly to our sign up page, or following the instructions in your signup email (if you were invited to the platform by a colleague).

  • Log in to the Demyst platform with your new credentials on the log in page.

  • The Demyst home page comprises 3 sections:

    1. A free package of Demyst credits to help you get started with your first Data API

      getting_started_1
    2. Recently Featured API Recipes. Recipes are Data API templates. Step 3 discusses Recipes in greater detail.

      getting_started_2
    3. Recently Featured Datasets.Demyst’s Data Catalog includes hundreds of datasets available for deployment. Step 2 discusses the Data Catalog in greater detail.

      getting_started_3

This concludes signing up, logging in to the Demyst Platform, and browsing the home page.

Step 2: Finding a relevant product in Demyst’s Data Catalog

Tiles in the data catalog show digest descriptions, country coverage, pricing, data dictionaries, and other details for the hundreds of datasets that can be deployed through Demyst. Listings also include metadata to support easier browsing.

  • Navigate to the Data Catalog by starting on the home page and clicking the “Dataset Catalog” button on the left, outlined in red below:

    getting_started_4
  • The Data Catalog shows “tiles” of datasets available for deployment. Filter the listed datasets and search for keywords to find external data that is relevant to your business problem.

    getting_started_5
  • Explore specific datasets by clicking on them. Their detail pages show more information:

    1. The description of the dataset shows a summary of its contents

    2. The price shows the number of credits required to include a dataset in a Data API transaction

    3. The recipes show examples that use a given dataset

      getting_started_6
    4. The inputs show which information will be necessary to call a deployed Data API using this dataset

    5. The outputs show which information can be retrieved by calling a deployed Data API using this dataset

      getting_started_7
  • If you are having difficulty finding a particular dataset or type of data, you can request assistance through the chat bubble on the bottom right of the Demyst platform. You can also contact our sales team directly.

This concludes the navigation of Demyst’s Data Catalog to browse and find data of interest.

Step 3: Learning about recipes and finding relevant uses

Demyst’s Recipes are template Data APIs that typically combine customizable logic and multiple datasets to solve business problems. These external data solutions are available for immediate deployment through the Demyst platform.

Recipes can be reviewed to explore their applicability for common use cases, country coverage, pricing, and similar recommendations. Listings also include metadata to support easier browsing.

  • Navigate to the Recipe Catalog by starting on the home page and clicking the “Recipe Catalog” button on the left, shown in red below:

    getting_started_8
  • Explore specific Recipes by clicking on them — their detail pages show more information:

    1. The description of the recipe shows a summary of its contents

    2. The price shows the number of credits required to run a Data API transaction

      getting_started_9
    3. The datasets show additional detail about all the datasets involved

    4. The applicable use cases and related Recipes can help identify the most appropriate solution for your problem

      getting_started_10
    5. The inputs show which information will be necessary to call a deployed Data API using this recipe

    6. The configuration shows the JSON syntax that defines the recipe, including which datasets are used and what logic is applied

  • If you are having difficulty finding a recipe to solve your problem, you can request assistance through the chat bubble on the bottom right of the Demyst platform. You can also contact our sales team directly.

This concludes the navigation of Demyst’s Recipe Catalog to browse and find recipes for solving business problems.

Step 4: Creating and testing Data APIs by cloning dataset connectors and recipes

Datasets and recipes from Demyst’s catalogs can be used as the basis for Data APIs that are immediately available for evaluation.

  • Dataset connectors and Recipes can be cloned with the “Create Data API” button, outlined in red below. Note that you must agree to use the data for evaluation purposes only.

    getting_started_11
  • Clicking the button redirects you to the newly created Data API, which you can test with a set of inputs. You must meet the requirements from at least one set of minimum input requirements listed on the right of the Data API screen before you can press “Send Request.”

    getting_started_12
  • Your results are displayed in the “Response” section, presented in JSON format. If variables are listed in the “refine” section of the JSON response, they have been selected using the logic that was applied in the Data API’s configuration. The data grouped under the “output” section of the JSON response is the complete set of returned variables, grouped by each dataset used in the Data API.

    getting_started_13

This concludes the creation and testing of Data APIs.

Step 5: Editing the configuration of a Data API

Data API configurations can be edited to add or remove datasets and business logic — they can be customized to suit specific needs.

  • When viewing a Data API, click on ‘configuration’ to expand the section. Click “edit configuration” to make changes to the JSON script.

    getting_started_13
  • Refer to the API configuration documentation to make changes.
    Some simple examples include:

    1. Adding the following text under the ”provider” section to include a new dataset:

                              
                              "dataset_name": {
                                  "version": "$latest"
                              }
                              
                            
    2. Adding the following to include a new variable in the “refine” section:

                              
                                  "what_you_want_to_call_this_variable": "dataset_name.variable_path”
                              
                            
  • Remember to click “save changes” so that your Data API edits are applied. Test the edited API to check your results.

    getting_started_14

This concludes making edits to the configuration of a Data API.

Step 6: Running a programmatic request against a Data API

Once Data APIs are built in the Demyst platform, they are typically run programmatically, outside the platform, as part of core applications or workflows. This can be done through a curl request.

(To access a Data API in another way or learn about Data API integrations in more detail, refer to our API Integration documentation.)

  • Generate a key from this page by clicking “Generate API Key” and choosing an appropriate name and role for the key (typically “user”). A popup on screen will show your successfully generated API key. Copy this information, save it, and manage it appropriately. The API key is not viewable once you navigate away from the popup screen.

    Select “API Keys” — this may need to be done by an administrator in your organization if you do not have the required permissions.

    getting_started_15
  • Generate a key from this page by clicking “Generate API Key” and choosing an appropriate name and role for the key (typically “user”). A popup on screen will show your successfully generated API key. Copy this information, save it, and manage it appropriately. The API key is not viewable once you navigate away from the popup screen.

    getting_started_16

    The API Key in this screenshot is no longer valid — you must generate your own key.

  • Navigate back to your Data API by clicking the ‘Data API’ section and choosing your Data API.

    getting_started_17
  • Navigate to the documentation section for your Data API. Copy the text for the sample curl request provided. Paste it into a script editor.

    getting_started_18
  • Complete the sample curl request with your API Key, and add the same inputs that were used when testing your Data API in the Demyst platform. Paste the completed curl request into your terminal and press enter to run it. The available results will match the results that would be seen in the platform.

    getting_started_19

This concludes running a programmatic request against a Data API, which would be done in a production workflow.

Step 7: Moving a Data API from evaluation to production

After an API has been edited and configured to suit a specific business need, it must be transitioned from an evaluation API to a production API. This change allows organizations to use APIs for production purposes, and it enables billing for data usage, but the API cannot be edited further.

  • Contact Demyst through the chat bubble on the bottom right of the platform or by completing a contact form.

  • Your organization will be provided with a Commercial Use Statement of Work (SOW). This agreement covers the commercial terms associated with using Data APIs on the Demyst platform, and it must be signed before your request is approved.

  • A Demyst employee will update your Data API and tag it as a Production API on the platform:

    getting_started_20

This concludes the creation of a Production API.

Step 8: Reviewing transaction logs for a Data API and viewing reporting dashboards

Production APIs can be monitored for performance and billing purposes. This is facilitated by Demyst’s Data API dashboards.

  • After a Data API is in Production, clicking on it in the “Data API” section of the platform will display its performance dashboards. There are 3 primary dashboards:

    1. Transactions shows the total number of transactions ran against a Data API over time.

      getting_started_21
    2. Response Time shows metrics related to the time used by the Data API when returning responses.

      getting_started_22
    3. Errors shows metrics related to errors logged by the Data API. More detail regarding these errors can be found in the “Error Logs” section of the Data API.

      getting_started_23
  • You can review the performance of individual datasets in a Data API by clicking “change report.” This can provide more detail behind a Data API’s aggregate response times.

    getting_started_24
  • The “billing” section of the platform shows information regarding browsing consumption for production Data APIs and credits due.

    getting_started_25

This concludes the review of dashboards for monitoring and managing Production Data APIs.