API IN

1

Register your API into XTOPIA

To connect third party API into XTOPIA

2

Register API as data source

Make API data available to use in editor

3

Consume API data

Make requests to third party API

STEP 1: Register third party API into XTOPIA

Please login to your existing XTOPIA account to get started.

  1. Go to XTOPIA > APPS >  API Builder > API Registration to register your third party API.
  2. Enter the following information & save it.
    1. API Name
    2. API Main URL
    3. Type of Authorization


After registered, you can start to add the API function & mapping the fields.

NOTE:

  1. API function URL
    • enter API URL without the base URL. The base URL should be set in the field API Main URL. 
    • eg: < Base URL > api/rest
  2. Mapping fields:
    • to define the API response field name & type.

STEP 2: Register API as data source

To use the third party API data in editor, you must register it as data source.

STEP 3: Consume API data in editor

API data (which registered in data source) can be consumed by the rich media object (RMO).


How to bind API data into Rich Media Object (RMO)

  1. Drag the RMO into editor.
  2. Change the RMO's data from "Manual" to "Dynamic Data".
  3. Drag basic object (eg: text, image) into RMO, then bind the content field to data field.

 

FAQs

Copyright © 2024 XTOPIA.IO  |  All rights reserved.
Ooops!
Generic Popup2