n8n-nodes-semble / credentials/SembleApi.credentials / SembleApi

Class: SembleApi¶

Defined in: credentials/SembleApi.credentials.ts:22

Semble API credential type for n8n SembleApi

Implements¶

Description¶

Defines the authentication mechanism for Semble's GraphQL API using JWT tokens

Implements¶

ICredentialType

Constructors¶

Constructor¶

new SembleApi(): SembleApi

Returns¶

SembleApi

Properties¶

name¶

readonly name: string = "sembleApi"

Defined in: credentials/SembleApi.credentials.ts:24

The unique identifier for this credential type

Implementation of¶

ICredentialType.name

displayName¶

readonly displayName: string = "Semble API"

Defined in: credentials/SembleApi.credentials.ts:27

Display name shown in n8n UI

Implementation of¶

ICredentialType.displayName

documentationUrl¶

readonly documentationUrl: string = "https://docs.semble.io/"

Defined in: credentials/SembleApi.credentials.ts:30

Link to Semble API documentation

Implementation of¶

ICredentialType.documentationUrl

properties¶

properties: INodeProperties[]

Defined in: credentials/SembleApi.credentials.ts:37

Configuration properties for the credential

Description¶

Defines the input fields for API token and GraphQL endpoint

Implementation of¶

ICredentialType.properties

authenticate¶

authenticate: IAuthenticateGeneric

Defined in: credentials/SembleApi.credentials.ts:83

Authentication configuration for Semble API requests

Configures n8n to automatically include the API token in the x-token header for all requests made to the Semble API. The token is interpolated from the credential's apiToken field at runtime.

The authentication uses: - Generic authentication type for maximum flexibility - x-token header for JWT token authentication - Content-Type header set to application/json for GraphQL

Example¶

// This configuration automatically adds headers like:
{
  "x-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "Content-Type": "application/json"
}

Since¶

2.0.0

Description¶

Uses generic authentication with x-token header containing JWT

Implementation of¶

ICredentialType.authenticate

test¶

test: ICredentialTestRequest

Defined in: credentials/SembleApi.credentials.ts:99

Connection test configuration

Description¶

Tests the API connection using GraphQL introspection query

Implementation of¶

ICredentialType.test