External API Lookup

The External API Lookup extension allows you to fetch resources from third-party/external apps using APIs and display the resources in a field in the content type of your stack

Thus, while creating an entry, you can select one or more resources from a list of possible values as an input value for the field.

This step-by-step guide explains how to create an External API Lookup extension for your content types:

  1. Add the “External API Lookup” custom field to your Stack
  2. Use your custom field
  1. Add the “External API Lookup” custom field to your stack

    To add the External API Lookup custom field to your stack, log in to your Contentstack account and perform the following steps:

    1. Go to your stack and click on the “Settings” icon on the left navigation panel.
    2. Click on Extensions.
    3. On the Extensions page, click on the + New Extension button, and select Create new.External_API_Lookup_1_Highlighted.png
    4. In the Select Extension Type window, select Custom Field.External_API_Lookup_2_no_highlight.png
    5. On the Create New Extension page, enter values in the fields as given below:
      • Title (required): Provide a suitable title, for example “External API Lookup,” for your custom field. This title will be visible when you select the extension in the custom field in your content type.
      • Field Data Type (required): Select the data type in which the input data of the field should be saved in Contentstack. In this case, select Text.
      • Multiple (optional): Leave this field unchecked.
      • Hosting method (required): Select Hosted by Contentstack as the hosting method for this content type.
      • External source code (required): In this field, you need to enter the extension code. To get the code, download it from our repository. Then, open the index.html file, located at the root folder, and paste its code in this field.
      • Config Parameter (required): Provide values for the config parameters if you have used any in your source code. For the External API Lookup extension, you need to provide the Rest API endpoint that fetches the list. Here’s an example:
        {
            "url": "https://jsonplaceholder.typicode.com/users/
        }
    6. Save the custom field.

    Now, let’s understand how you can start using your extension in your content type.

  2. Use your custom field

    Once you have added a custom field, you can use it in your content type like any other field. To add a custom field in your content type, perform the following steps:

    1. In your stack, click on “Content Models” on the left navigation panel. By default, you will be on the Content Type page.

    2. Create a content type by clicking on the + New Content Type. button. Enter the relevant details for the content type and click on Save. This leads you to the Content Type Builder page where you can add the relevant fields.
    3. Add the Custom field in your content type.
    4. Select External API Lookup from the dropdown and set the other properties of your custom field.External_API_Lookup_3_Highlighted.png

      Note: You can provide specific instance-level configuration settings for your Custom Field extension. You can read more about Config Parameters in our documentation.

    5. After adding other relevant fields in your Content Type, click on Save and Close.

      This will create your Content Type. Now, go to the content type andcreate a new entry. Enter the relevant details. In the External API Lookup field, select any value while creating an entry for this content type as shown below.

Was this article helpful?

Thanks for your feedbackSmile-icon

On This Page