@celeropress/sdk
v1.0.0
Published
Official CeleroPress API SDK for JavaScript/TypeScript
Downloads
23
Maintainers
Readme
@celeropress/sdk
Official JavaScript/TypeScript SDK for the CeleroPress Marketing Suite API.
Installation
npm install @celeropress/sdk
# or
yarn add @celeropress/sdkQuick Start
import { CeleroPress } from '@celeropress/sdk';
// Initialize the client
const client = new CeleroPress({
apiKey: 'cp_live_your_api_key_here'
});
// Test authentication
const authTest = await client.testAuth();
console.log('Connected:', authTest.message);
// List contacts
const contacts = await client.contacts.list({
limit: 10,
tags: ['journalist']
});
// Create a new contact
const newContact = await client.contacts.create({
firstName: 'Max',
lastName: 'Mustermann',
email: '[email protected]',
company: 'Example GmbH',
tags: ['press', 'tech']
});
// Search across all entities
const searchResults = await client.search('tech journalist', {
types: ['contacts', 'companies']
});API Documentation
Full API documentation available at: https://www.celeropress.com/dashboard/developer/docs
Features
- ✅ Full TypeScript support
- ✅ Promise-based API
- ✅ Automatic error handling
- ✅ Built-in retry logic
- ✅ Comprehensive API coverage
API Coverage
- Contacts - Full CRUD operations
- Companies - Full CRUD operations
- Webhooks - Create and manage webhooks
- Search - Global search across entities
- Bulk Operations - Import/Export large datasets
Requirements
- Node.js 14.0 or higher
- CeleroPress API Key (get one at https://www.celeropress.com/dashboard/admin/api)
License
MIT
Support
- Documentation: https://www.celeropress.com/dashboard/developer
- Issues: https://github.com/celeropress/sdk-js/issues
- Email: [email protected]
