222 lines
9.1 KiB
JSON
222 lines
9.1 KiB
JSON
{
|
|
"type": "API Map",
|
|
"definition": {
|
|
"text": "An API Map represents the mapping of an API so that is can be consumed by bots within Superalgos. API Maps are created by users and shared as Plugins so that any other community member can use them with their bots. ",
|
|
"updated": 1621016177698,
|
|
"translations": [
|
|
{
|
|
"language": "ES",
|
|
"text": "Un API Map representa el mapeo de una API para que pueda ser consumida por bots dentro de Superalgos. API Maps Son creados por los usuarios y compartidos como Plugins para que cualquier otro miembro de la comunidad pueda usarlos con sus bots.",
|
|
"updated": 1628046227514
|
|
}
|
|
]
|
|
},
|
|
"paragraphs": [
|
|
{
|
|
"style": "Text",
|
|
"text": "The way to create an API Map is to read the API's documentation for each endpoint as well as the Data Mining Topic. These sources will provide you with all the information you need to make a successful API Map.",
|
|
"updated": 1622847308932
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "The basic way you can think about an API Map is as a representation of the URL link needed to request information from the API as well as the layout of the data returned by the API. This means that an API Map hold all the information needed to request data and decipher the data once it is returned.",
|
|
"updated": 1622847337343
|
|
},
|
|
{
|
|
"style": "Title",
|
|
"text": "How are API Maps used?",
|
|
"updated": 1622847013897
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "API Maps are used by API Data Fetcher Bots to request and save the data from an API. In order to do this a user needs to set up a task to run the bot. This set up is done automatically as part of the Install Market procedure if both an API Map and its data mine is detected within the Worksapce. From within that Task, a reference to the API Map is established.",
|
|
"updated": 1622847596702
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "When the Task is run, the UI will send to the Task Server all the definitions inside the API Map so that the API Data Fetcher Bot can use them to connect to the API Server, fetch data from it, and correctly interpret the responses."
|
|
},
|
|
{
|
|
"style": "Title",
|
|
"text": "How to Read an API Request URL",
|
|
"updated": 1622847733042
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "The API you are trying to map should have it's API Endpoints documented. If not, check any examples they may provide for how to request the data and see if there are inner folders below the main folder of the API Enpoint. Each one of these folders are an API Path Parameter that needs to be defined.",
|
|
"updated": 1622847657548
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "Here are some examples of API request URLs:"
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": " https://api.coingecko.com/api/v3/coins/bitcoin?"
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": "https://data.messari.io/api/v1/assets/btc?fields=id,slug,symbol,metrics/market_data",
|
|
"updated": 1622848130436
|
|
},
|
|
{
|
|
"style": "Subtitle",
|
|
"text": "Sections of an API Request URL"
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "Let's break down one of these URLs and identify each part of it."
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "Internet Protocol: This is the section on the very front of almost any internet link you will see."
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": " https"
|
|
},
|
|
{
|
|
"style": "Note",
|
|
"text": "You define this using the protocol config property in the main API Map node.",
|
|
"updated": 1622847750228
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "Root Domain Name: This is the section of the URL that is before the first backslash:"
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": " data.messari.io"
|
|
},
|
|
{
|
|
"style": "Note",
|
|
"text": "You define this using the hostName config property in the main API Map node.",
|
|
"updated": 1622847770913
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "API Path: This is the section that defines the main path to the API:"
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": " api"
|
|
},
|
|
{
|
|
"style": "Note",
|
|
"text": "You define this using the path config property in the main API Map node.",
|
|
"updated": 1622847800732
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "API Version Number: This is the section that defines the API version to which you are making requests."
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": " v1"
|
|
},
|
|
{
|
|
"style": "Note",
|
|
"text": "You define this using the codeName config property in the API Version node.",
|
|
"updated": 1622847982153
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "API Endpoint: This is the section that tells the API what kind of data you wish to request.",
|
|
"updated": 1622847877226
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": "assets"
|
|
},
|
|
{
|
|
"style": "Note",
|
|
"text": "You define this using the config codeName property of the API Endpoint node.",
|
|
"updated": 1622847959761
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "Path Parameters: These are the remaning sections of the path before the question mark they further narrow down what data you wish to request from the API. In this case we want to receive data about bitcoin:",
|
|
"updated": 1622848189591
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": " btc"
|
|
},
|
|
{
|
|
"style": "Note",
|
|
"text": "You define each of these using the codeName config property in the API Path Parameter node.",
|
|
"updated": 1622848212517
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "Query Parameters: These are all the sections after the question mark. They are often used to pair down the amount of data returned by the API so that you only receive what you are interested in:",
|
|
"updated": 1622848284105
|
|
},
|
|
{
|
|
"style": "Javascript",
|
|
"text": "fields=id,slug,symbol,metrics/market_data"
|
|
},
|
|
{
|
|
"style": "Note",
|
|
"text": "You define these using the codeName and value config properties of the API Query Parameter node."
|
|
},
|
|
{
|
|
"style": "Include",
|
|
"text": "Foundations->Topic->Data Mining - Fetching Data From APIs->Main Workflow",
|
|
"updated": 1621951793419
|
|
},
|
|
{
|
|
"style": "Include",
|
|
"text": "Foundations->Topic->Data Mining - Fetching Data From APIs->Step By Step",
|
|
"updated": 1622120722583
|
|
},
|
|
{
|
|
"style": "Title",
|
|
"text": "API Map Configuration",
|
|
"updated": 1622895474056
|
|
},
|
|
{
|
|
"style": "Subtitle",
|
|
"text": "Properties"
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "codeName: this must be the same codename as the Data Mine codename in order for the Install New Market procedure to link them properly at the API Map Reference node.",
|
|
"updated": 1622895563618
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "protocol: the protocol to be used to access the API. For now either http or https.",
|
|
"updated": 1622895574503
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "portNumber: the port at which the API server is listening.",
|
|
"updated": 1622895581034
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "hostName: the domain name or IP address of the API server.",
|
|
"updated": 1622895586641
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "path: the URL path to where the API is located within the remote server.",
|
|
"updated": 1622895592146
|
|
},
|
|
{
|
|
"style": "List",
|
|
"text": "millisecondsBetweenCalls: [Optional] the number of milliseconds to wait before calling the remote host. This is particuary useful if there is pagination, so that there is a delay before requesting each page.",
|
|
"updated": 1622863477228
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "Here is an example API Map config:"
|
|
},
|
|
{
|
|
"style": "Json",
|
|
"text": "{\n \"codeName\": \"CoinGecko\",\n \"protocol\": \"https\",\n \"portNumber\": \"\",\n \"hostName\": \"api.coingecko.com\",\n \"path\": \"api\",\n \"millisecondsBetweenCalls\": 4000\n}",
|
|
"updated": 1622863537968
|
|
}
|
|
]
|
|
} |