Description

n8n-nodes-timetonic

This is an n8n community node that provides integration with the TimeTonic API. It allows you to interact with TimeTonic's workflow automation platform directly from your n8n workflows.

TimeTonic is a comprehensive business management platform that offers project management, CRM, and workflow automation capabilities.

Installation

Follow the installation guide in the n8n community nodes documentation.

Community Nodes (Recommended)

1. Go to Settings > Community Nodes
2. Select Install
3. Enter n8n-nodes-timetonic in Enter npm package name
4. Agree to the risks of using community nodes: select I understand the risks of installing unverified code from a public source
5. Select Install

After installing the node, you can use it like any other node. n8n displays the node in search results in the Nodes panel.

Manual Installation

npm install n8n-nodes-timetonic

Required Credentials

To use this node, you need to configure the following TimeTonic API credentials:

• OAuth Key: Your TimeTonic OAuth key
• OAuth User ID: The OAuth user ID (o_u parameter)
• User ID: The user ID (u_c parameter, usually same as OAuth User ID)
• Session Key: A valid session key for API authentication
• Base URL: TimeTonic API base URL (default: https://timetonic.com/live/api.php)

Note: You need to obtain a session key separately using the TimeTonic API's createSesskey operation before using this node.

Getting Your Credentials

To obtain your TimeTonic API credentials:

1. Log in to your TimeTonic account
2. Navigate to your account settings or developer section
3. Generate or locate your OAuth key and user IDs
4. Refer to the TimeTonic API documentation for detailed instructions

Supported Operations

Authentication

• Drop All Sessions: Drop all active sessions except the current one

User

• Get User Info: Retrieve information about the authenticated user

Table

• List Table Rows by ID: Retrieve specific table rows by their IDs 2
• Create or Update Table Row: Create a new row or update an existing row in a table 1

Example Usage

Authentication

1. Drop All Sessions: Clean up active sessions

User Operations

1. Get User Info: Retrieve authenticated user information

Table Operations

1. List Table Rows by ID:

   • Book Owner: Book owner identifier (required)
   • Category ID: Category (table) ID (required)
   • Optional parameters: View ID, format (columns/rows/diff_ready_rows), max rows, last modified after timestamp, API version
   • Returns data from the specified table

2. Create or Update Table Row:

   • Create new row: Set Row ID to "tmpNEW_ROW"
   • Update existing row: Provide the actual row ID
   • Field Values: JSON object with field IDs and values 1
   • Example: {"fieldID1": "value1", "fieldID2": "value2"}
   • Category ID: The id of the category in which the new row must be created (optional if fieldValues is passed)
   • Link Separator: The text separator used to separate link values (default: ",")
   • Encrypted Field Passwords: JSON string which associates the encrypted field id with its password (e.g. {"field1": "password1","field2": "password2"})
   • Bypass URL Trigger: Control whether to trigger automations (default: true)

Basic Authentication Flow

1. Add the TimeTonic node to your workflow
2. Configure your credentials
3. Select "Authentication" as the resource
4. Choose "Create Session Key" as the operation
5. Execute the workflow to get a session key for further API calls

Session Management

The node automatically handles session creation for operations that require authentication. The session key is used internally for API requests that need it.

All operations require proper TimeTonic API credentials configured in the node.

Development

Prerequisites

• Node.js (version 20.15 or higher)
• npm
• n8n installed globally: npm install n8n -g

Setup

1. Clone this repository:

   git clone https://github.com/marvinl/n8n-nodes-timetonic.git
   cd n8n-nodes-timetonic
   

2. Install dependencies:

   npm install
   

3. Build the node:

   npm run build
   

4. Link the package for local development:

   npm link
   

5. Link to your global n8n installation:

   cd ~/.n8n
   npm link n8n-nodes-timetonic
   

Development Workflow

1. Make changes to the source code
2. Run the build command: npm run build
3. Restart n8n to see your changes

Code Quality

• Linting: npm run lint
• Auto-fix linting issues: npm run lintfix
• Format code: npm run format

Testing

To test your node:

1. Start n8n: n8n start
2. Create a new workflow
3. Add your TimeTonic node
4. Configure credentials and test operations

API Reference

This node is built based on the TimeTonic API documentation. Key features include:

• Session-based authentication using OAuth keys
• RESTful API endpoints
• JSON response format
• Error handling with status codes

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Development Guidelines

1. Follow the existing code style
2. Add appropriate error handling
3. Update documentation for new features
4. Test your changes thoroughly
5. Follow n8n's community node guidelines

License

MIT

Resources

• n8n community nodes documentation
• TimeTonic API documentation
• n8n node development guide

Support

If you encounter any issues or have questions:

1. Check the TimeTonic API documentation
2. Review the n8n community nodes documentation
3. Open an issue in this repository

Version History

0.1.0

• Initial release
• Basic authentication operations
• Session management
• User information retrieval (placeholder)