Libraries tagged by seq

sendx/sendx-php-sdk

0 Favers
11605 Downloads

# SendX REST API Documentation ## ๐Ÿš€ Introduction The SendX API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. **Key Features:** - ๐Ÿ”’ **Security**: Team-based authentication with optional member-level access - ๐ŸŽฏ **Resource-Oriented**: RESTful design with clear resource boundaries - ๐Ÿ“Š **Rich Data Models**: Three-layer model system (Input/Output/Internal) - ๐Ÿ”— **Relationships**: Automatic prefix handling for resource relationships - ๐Ÿ“ˆ **Scalable**: Built for high-volume email marketing operations ## ๐Ÿ—๏ธ Architecture Overview SendX uses a three-layer model architecture: 1. **Input Models** (`RestE*`): For API requests 2. **Output Models** (`RestR*`): For API responses with prefixed IDs 3. **Internal Models**: Core business logic (not exposed in API) ## ๐Ÿ” Security & Authentication SendX uses API key authentication: ### Team API Key ```http X-Team-ApiKey: YOUR_TEAM_API_KEY ``` - **Required for all requests** - Team-level access to resources - Available in SendX Settings โ†’ Team API Key ## ๐Ÿ†” Encrypted ID System SendX uses encrypted IDs for security and better developer experience: - **Internal IDs**: Sequential integers (not exposed) - **Encrypted IDs**: 22-character alphanumeric strings - **Prefixed IDs**: Resource-type prefixes in API responses (`contact_`) ### ID Format **All resource IDs follow this pattern:** ``` _ ``` **Example:** ```json { "id": "contact_BnKjkbBBS500CoBCP0oChQ", "lists": ["list_OcuxJHdiAvujmwQVJfd3ss", "list_0tOFLp5RgV7s3LNiHrjGYs"], "tags": ["tag_UhsDkjL772Qbj5lWtT62VK", "tag_fL7t9lsnZ9swvx2HrtQ9wM"] } ``` ## ๐Ÿ“š Resource Prefixes | Resource | Prefix | Example | |----------|--------|---------| | Contact | `contact_` | `contact_BnKjkbBBS500CoBCP0oChQ` | | Campaign | `campaign_` | `campaign_LUE9BTxmksSmqHWbh96zsn` | | List | `list_` | `list_OcuxJHdiAvujmwQVJfd3ss` | | Tag | `tag_` | `tag_UhsDkjL772Qbj5lWtT62VK` | | Sender | `sender_` | `sender_4vK3WFhMgvOwUNyaL4QxCD` | | Template | `template_` | `template_f3lJvTEhSjKGVb5Lwc5SWS` | | Custom Field | `field_` | `field_MnuqBAG2NPLm7PZMWbjQxt` | | Webhook | `webhook_` | `webhook_9l154iiXlZoPo7vngmamee` | | Post | `post_` | `post_XyZ123aBc456DeF789GhI` | | Post Category | `post_category_` | `post_category_YzS1wOU20yw87UUHKxMzwn` | | Post Tag | `post_tag_` | `post_tag_123XyZ456AbC` | | Member | `member_` | `member_JkL012MnO345PqR678` | ## ๐ŸŽฏ Best Practices ### Error Handling - **Always check status codes**: 2xx = success, 4xx = client error, 5xx = server error - **Read error messages**: Descriptive messages help debug issues - **Handle rate limits**: Respect API rate limits for optimal performance ### Data Validation - **Email format**: Must be valid email addresses - **Required fields**: Check documentation for mandatory fields - **Field lengths**: Respect maximum length constraints ### Performance - **Pagination**: Use offset/limit for large datasets - **Batch operations**: Process multiple items when supported - **Caching**: Cache responses when appropriate ## ๐Ÿ› ๏ธ SDKs & Integration Official SDKs available for: - [Golang](https://github.com/sendx/sendx-go-sdk) - [Python](https://github.com/sendx/sendx-python-sdk) - [Ruby](https://github.com/sendx/sendx-ruby-sdk) - [Java](https://github.com/sendx/sendx-java-sdk) - [PHP](https://github.com/sendx/sendx-php-sdk) - [JavaScript](https://github.com/sendx/sendx-javascript-sdk) ## ๐Ÿ“ž Support Need help? Contact us: - ๐Ÿ’ฌ **Website Chat**: Available on sendx.io - ๐Ÿ“ง **Email**: [email protected] - ๐Ÿ“š **Documentation**: Full guides at help.sendx.io --- **API Endpoint:** `https://api.sendx.io/api/v1/rest` [](https://god.gw.postman.com/run-collection/33476323-44b198b0-5219-4619-a01f-cfc24d573885?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D33476323-44b198b0-5219-4619-a01f-cfc24d573885%26entityType%3Dcollection%26workspaceId%3D6b1e4f65-96a9-4136-9512-6266c852517e)

Go to Download


diarmuidie/niceid

15 Favers
57876 Downloads

PHP library to generate short, non-sequential, URL-friendly hashes of incremental IDs. Similar to YouTube (https://www.youtube.com/watch?v=dQw4w9WgXcQ) and Bitly (http://bit.ly/1D0CAzd) URLs.

Go to Download


datatables.net/datatables.net-rowreorder

4 Favers
5962 Downloads

RowReorder adds end user reordering of rows in a DataTable through click-and-drag mouse and touch operations. RowReorder provides full support for Editor allowing end users to update sequential information in a fast and easy manner. This is RowReorder for DataTables

Go to Download


xp-forge/sequence

1 Favers
14074 Downloads

Data sequences

Go to Download


vitaliyboyko/magento-seq

2 Favers
94 Downloads

Magento 2 local-development Seq instrumentation module

Go to Download


sequra/magento2-sequra-core-hyva-compat

0 Favers
735 Downloads

Hyvรค Themes Compatibility module for Sequra_Core

Go to Download


revinate/sequence

5 Favers
25534 Downloads

A functional programming library for PHP

Go to Download


opengento/module-sales-sequence

6 Favers
3670 Downloads

This module allows to setup the sales sequence settings directly withing the configuration.

Go to Download


lyrasoft/sequence

1 Favers
4438 Downloads

LYRASOFT sequence package.

Go to Download


inisiatif/sequence

0 Favers
6215 Downloads

Sequence package using in Inisiatif Zakat Indonesia

Go to Download


friends-of-ddd/sequence-number-generator

0 Favers
953 Downloads

Sequence Number Generator

Go to Download


diephp/sequences

0 Favers
1342 Downloads

Iterator of sequences

Go to Download


dejodev/laravel-sequence-number-generator

1 Favers
193 Downloads

Generate complex sequencenumbers using DB locking to ensure each number is unique

Go to Download


ameax/sequence-number

1 Favers
480 Downloads

A laravel package to configure and generate sequence numbers for invoices

Go to Download


sylius/sequence-bundle

4 Favers
104646 Downloads

Sequence system for Symfony2 applications.

Go to Download


<< Previous Next >>