Libraries tagged by yz
sendx/sendx-php-sdk
12695 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)
mantoufan/yzhanip
1363 Downloads
Crawl, match, parse IP or IP range, check if IP or range is in another range. Support IPv4, IPv6, IP Interval, Wildcard and CIDR. Check if IP is Cloudflare node IP, Google bot IP. ็ฌๅ๏ผๆญฃๅๅน้ ๏ผ่งฃๆ IP ๅ IP ่ๅด๏ผๆฃๆต IP ๆ่ๅดๆฏๅฆๅจๅฆไธไธช่ๅดไธญใๆฏๆ IPv4๏ผIPv6๏ผๅบ้ดใ้้ ็ฌฆๆ CIDR ่กจ็คบ็ IP ่ๅดใๆฃๆต IP ๆฏๅฆๆฏ Cloudflare ่็นๆ Google ๆผซๆธธๅจ IP
mantoufan/yzhangateway
1430 Downloads
Developing PHP SDK for any API. ไธบไปปไฝ API ๅฟซ้ๅผๅ PHP SDK.
mantoufan/yzhancache
1518 Downloads
Simple, effient cache class for PHP. ็ฎๅใ้ซๆ็ PHP ็ผๅญ็ฑป
yzh52521/webman-validate
1986 Downloads
The webman Validate Package
yzh52521/webman-throttle
2237 Downloads
Webmanๆกๆถ้ๆตไธญ้ดไปถ
yzh52521/webman-hash
5955 Downloads
Use hash in webman Framework, The Laravel Hash component implements library.
yzh52521/webman-event
391 Downloads
Use event in webman Framework, The Laravel EventDispatcher component implements library.
yzh52521/think-mailer
323 Downloads
A powerful and beautiful php mailer for All of ThinkPHP and Other PHP Frameworks based Symfony mailer
yzh52521/think-lock
1082 Downloads
thinkphp lock plugin
yzh52521/think-jwt
273 Downloads
JSON Web Token (JWT) for Thinkphp plugin
yzh52521/think-filesystem
3891 Downloads
thinkphp6.1 for filesystem,include Aliyun and Qiniu COS OBS
yzh52521/flysystem-oss
13034 Downloads
Aliyun OSS Adapter for Flysystem v3.0
yzh52521/flysystem-obs
12263 Downloads
Flysystem adapter for the obs storage.
yzen.dev/mono-processor
6124 Downloads
This Processor will display in the logs bread crumbs by which you can more quickly and accurately identify the cause of the error.