n8n/packages/nodes-base/credentials/KoBoToolboxApi.credentials.ts

45 lines
1,000 B
TypeScript
Raw Normal View History

import {
IAuthenticateGeneric,
ICredentialTestRequest,
ICredentialType,
NodePropertyTypes,
} from 'n8n-workflow';
export class KoBoToolboxApi implements ICredentialType {
name = 'koBoToolboxApi';
displayName = 'KoBoToolbox API Token';
// See https://support.kobotoolbox.org/api.html
documentationUrl = 'koBoToolbox';
properties = [
{
displayName: 'API Root URL',
name: 'URL',
type: 'string' as NodePropertyTypes,
default: 'https://kf.kobotoolbox.org/',
},
{
displayName: 'API Token',
name: 'token',
type: 'string' as NodePropertyTypes,
default: '',
hint: 'You can get your API token at https://[api-root]/token/?format=json (for a logged in user)',
},
];
authenticate = {
type: 'generic',
properties: {
headers: {
Authorization: '=Token {{$credentials.token}}',
},
},
} as IAuthenticateGeneric;
test: ICredentialTestRequest = {
request: {
baseURL: '={{$credentials.URL}}',
url: '/api/v2/assets/',
method: 'GET',
},
};
}