Consume a Component Resource
These are our Consume commands.
SDKs to consume Components and other entities.
Consume a Component Resource
Consume a component resource in your project.
const Component = require('linkapi-sdk/core/component');
const defaultOptions = {
headers: {},
queryString: {}
};
const myComponent = new Component('myComponent', defaultOptions);
const resourceMethod = 'GET'; // 'POST' | 'PUT' | 'DELETE' | 'PATCH'
const resourceName = 'products/{id}';
const result = await myComponent.request(resourceMethod, resourceName, {
body: {},
headers: {},
queryString: {},
params: {
id: '1'
}
})
Command (parameters) | Description |
---|---|
| Represents the |
| Which HTTP method that would be used. |
| The Resource URL to be called. |
| Use when there is dynamic parameters on the Resouce URL. For example: |
| Send additional info via QueryString |
| At the moment of creation of your Component, you set the Authentication Type. Once inside LinkApi, the consume follows some rules:
|
Consume Private Component
Use a Private Component in your project.
const products = await linkapi.component.request('componentName', {
httpMethod: 'GET',
resource: 'products',
urlParams: {},
queryString: {},
credentials: {},
});
Consume Function
Consume a Function to your project from Packages.
const result = await linkapi.function.execute('my-function', 'param1');
| Represents the file name of your Function. |
---|---|
| Accepts |
Updated about 2 years ago