Integration Fields

Integration type fields are custom getter functions that lets you populate the data from an external API into the field. For example, you might wanna fetch the customer information from stripe along with your users information. You can simply add the integration type field to connect with stripe and get the information in the same API.

intro.gif

Creating an Integration Field

Create an integration by clicking on the + button next to the table node on the graph. You can add multiple number of integration type fields to your table.

creating.png

After you select, type in the name of the field and select the service and the API you want the field to connect.

selecting.png

Once you create your field, you'll see some of the output fields branching out of it and some of them are hidden. These are the fields that your selected API will be returning. We show some these fields on the graph and keep the other hidden. If you want to check out all the parameters that the API is returning, you can check the API Preview at the top.

sub_fields.png

Properties

  • API Integration: The service you want to fetch data from. After selecting the service, pick the specific API you want to hit.

    api_integration

  • API Configuration

    All the configurations that you allowed to do for the API Integration you selected are shown here. This tab is dynamic, i.e. the configurations listed will change according to the API Integration you select.

    • Authentication If the API you selected any kind of authentication, you'll need to configure them here. For example, if you are fetching all the Pull Requests for an open sourced public repository, you are not required to add the authentication credentials. On the other hand if you are trying to do the same for a private repository, you'll have to authenticate it and add your credentials.

    Please note that the ways to authenticate different services are different. Not all the services you integrate will have the username-password authentication. For example, to authenticate your Stripe APIs you are required to add Stripe's API key.

    authentication

    • Required Fields The parameters that are required to be sent along with the API to work are listed here. Continuing on our previous example, to fetch the pull requests, you have to specify the owner/organisation and the repository's name. Errors will be shown if you leave any of the required parameters empty.

    Please note that the required fields will be different for each API. These are changed dynamically according to the API Integration you select.

    required_fields.png

    • Optional Fields All the option parameters that your selected API supports are listed down here. They are completely option to configure and the API will function properly if left empty.

    Please note that the optional fields will be different for each API. These are changed dynamically according to the API Integration you select.

    optional_fields

CMS

You can also see the raw data coming from these APIs in the CMS Section. You can't modify it since technically it's a getter function.

cms.png

Getting Data

Deploy your project after creating the integration and configuring the field. Now you'll start getting the data whenever you query your table.

playground.png

You'll not be able to use these fields in the code-editor as of now to write business logic on top of it. You can only fetch them with the APIs.

Did you find what you were looking for?
👍
👎
What went wrong?
Need more help?We have a thriving Discordcommunity that can help you with all things Canonic. →