Skip to content

ResourcesEmbedApi.md

Latest commit

 

History

History
164 lines (111 loc) · 4.98 KB

ResourcesEmbedApi.md

File metadata and controls

164 lines (111 loc) · 4.98 KB

BuiltByBitApi.ResourcesEmbedApi

All URIs are relative to https://api.builtbybit.com

Method HTTP request Description
getV2ResourcesEmbedDownload GET /v2/resources/embed/download Fetch the status of a download request
getV2ResourcesEmbedLatest GET /v2/resources/embed/latest Fetches the latest versions & license information
postV2ResourcesEmbedDownload POST /v2/resources/embed/download Submit a new download request

getV2ResourcesEmbedDownload

GetV2ResourcesEmbedDownload200Response getV2ResourcesEmbedDownload(token)

Fetch the status of a download request

Example

import BuiltByBitApi from 'built_by_bit_api';
let defaultClient = BuiltByBitApi.ApiClient.instance;
// Configure API key authorization: token
let token = defaultClient.authentications['token'];
token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix = 'Token';

let apiInstance = new BuiltByBitApi.ResourcesEmbedApi();
let token = "token_example"; // String | The token provided when submitting a download request.
apiInstance.getV2ResourcesEmbedDownload(token, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
token String The token provided when submitting a download request.

Return type

GetV2ResourcesEmbedDownload200Response

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getV2ResourcesEmbedLatest

GetV2ResourcesEmbedLatest200Response getV2ResourcesEmbedLatest(opts)

Fetches the latest versions & license information

Example

import BuiltByBitApi from 'built_by_bit_api';
let defaultClient = BuiltByBitApi.ApiClient.instance;
// Configure API key authorization: token
let token = defaultClient.authentications['token'];
token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix = 'Token';

let apiInstance = new BuiltByBitApi.ResourcesEmbedApi();
let opts = {
  'nonce': "nonce_example" // String | 32 character hash provided by an anti-piracy placeholder of the NONCE type. Must be from a resource download (cannot be an addon download’s nonce, etc).
};
apiInstance.getV2ResourcesEmbedLatest(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
nonce String 32 character hash provided by an anti-piracy placeholder of the NONCE type. Must be from a resource download (cannot be an addon download’s nonce, etc). [optional]

Return type

GetV2ResourcesEmbedLatest200Response

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

postV2ResourcesEmbedDownload

PostV2ResourcesEmbedDownload200Response postV2ResourcesEmbedDownload(opts)

Submit a new download request

Supported content types: - 'resource_version' - 'api_asset'

Example

import BuiltByBitApi from 'built_by_bit_api';
let defaultClient = BuiltByBitApi.ApiClient.instance;
// Configure API key authorization: token
let token = defaultClient.authentications['token'];
token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix = 'Token';

let apiInstance = new BuiltByBitApi.ResourcesEmbedApi();
let opts = {
  'postV2ResourcesEmbedDownloadRequest': new BuiltByBitApi.PostV2ResourcesEmbedDownloadRequest() // PostV2ResourcesEmbedDownloadRequest | 
};
apiInstance.postV2ResourcesEmbedDownload(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
postV2ResourcesEmbedDownloadRequest PostV2ResourcesEmbedDownloadRequest [optional]

Return type

PostV2ResourcesEmbedDownload200Response

Authorization

token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json