Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

16 Commits

Repository files navigation

SharpAPI GitHub cover

⚠️ DEPRECATED: SharpAPI PHP Client SDK

🔴 This Package is No Longer Maintained

This monolithic package (sharpapi/sharpapi-php-client) has been deprecated and replaced with specialized, endpoint-specific packages.

Why the Change?

  • Better Performance: Install only what you need
  • Smaller Dependencies: Reduced package size
  • Easier Maintenance: Each endpoint has its own repository
  • Clearer Documentation: Focused docs for each feature
  • Faster Updates: Independent versioning per endpoint

✅ What Should You Use Instead?

Please migrate to the new specialized packages listed below. Each package is focused on a specific SharpAPI endpoint and provides a cleaner, more maintainable solution.


📦 New Specialized Packages

📝 Content & Marketing Automation

PackageDescriptionInstallation
php-content-summarize-textAI-powered text summarizationcomposer require sharpapi/php-content-summarize-text
php-content-text-translatorAdvanced text translator (80+ languages)composer require sharpapi/php-content-text-translator
php-content-paraphrase-textParaphrase and rephrase contentcomposer require sharpapi/php-content-paraphrase-text
php-content-proofread-grammarProofread text and check grammarcomposer require sharpapi/php-content-proofread-grammar
php-content-keywords-tagsGenerate keywords and tags from contentcomposer require sharpapi/php-content-keywords-tags
php-content-spam-detectorDetect spam content with confidence scorecomposer require sharpapi/php-content-spam-detector
php-content-phone-detectorExtract and format phone numberscomposer require sharpapi/php-content-phone-detector
php-content-url-detectorExtract and validate URLs from textcomposer require sharpapi/php-content-url-detector
php-content-email-detectorExtract and validate email addressescomposer require sharpapi/php-content-email-detector

🛒 E-commerce

PackageDescriptionInstallation
php-ecommerce-product-review-sentimentAnalyze product review sentimentcomposer require sharpapi/php-ecommerce-product-review-sentiment
php-ecommerce-product-categorizationCategorize products with AIcomposer require sharpapi/php-ecommerce-product-categorization
php-ecommerce-product-intro-generatorGenerate product introductionscomposer require sharpapi/php-ecommerce-product-intro-generator
php-ecommerce-thank-you-emailGenerate personalized thank you emailscomposer require sharpapi/php-ecommerce-thank-you-email

🧑‍💻 HR Tech

PackageDescriptionInstallation
php-hr-related-skillsFind related skills with relevance scorescomposer require sharpapi/php-hr-related-skills
php-hr-related-job-positionsFind similar job positionscomposer require sharpapi/php-hr-related-job-positions
php-hr-job-description-generatorGenerate professional job descriptionscomposer require sharpapi/php-hr-job-description-generator

✈️ Travel, Tourism & Hospitality

PackageDescriptionInstallation
php-travel-review-sentimentAnalyze travel review sentimentcomposer require sharpapi/php-travel-review-sentiment
php-travel-hospitality-categorizationCategorize hospitality productscomposer require sharpapi/php-travel-hospitality-categorization
php-travel-tours-activities-categorizationCategorize tours and activitiescomposer require sharpapi/php-travel-tours-activities-categorization

🔍 SEO

PackageDescriptionInstallation
php-seo-tags-generatorGenerate SEO and social media META tagscomposer require sharpapi/php-seo-tags-generator

🛠️ Utilities

PackageDescriptionInstallation
php-utility-airportsGlobal airports database (30,000+ airports)composer require sharpapi/php-utility-airports
php-utility-job-positionsJob positions database APIcomposer require sharpapi/php-utility-job-positions

🔄 Migration Guide

Before (Old Package)

useSharpAPI\SharpApiService\SharpApiService;
$sharpApi = newSharpApiService(SHARP_API_KEY);
$statusUrl = $sharpApi->summarizeText($text, 'English');
$result = $sharpApi->fetchResults($statusUrl);

After (New Specialized Package)

useSharpAPI\ContentSummarize\SummarizeTextClient;
$client = newSummarizeTextClient(apiKey: SHARP_API_KEY);
$statusUrl = $client->summarizeText(
content: $text,
language: 'English'
);
$result = $client->fetchResults($statusUrl);

Key Differences

  1. Focused Imports: Import only the client you need
  2. Named Parameters: Use modern PHP 8.0+ named arguments
  3. Better Type Safety: Improved type hints and validation
  4. Smaller Footprint: Only install dependencies for features you use

⚠️ Important Notes

For Existing Users

This package will continue to work for projects that already use it. The source code remains unchanged, so your existing implementations won't break.

However, we strongly recommend migrating to the new specialized packages because:

  • ✅ This package will not receive any new features
  • ✅ Bug fixes and security updates will be limited
  • ✅ New SharpAPI endpoints will only be available in specialized packages
  • ✅ Better performance and smaller dependency footprint
  • ✅ Active development and support

When to Migrate

  • New Projects: Always use the new specialized packages
  • Existing Projects: Migrate during your next major update
  • composer update: You'll see deprecation warnings, but your code will still work

📚 Resources


💬 Need Help?

  • Questions? Open an issue on the specific package's GitHub repository
  • Feature Requests? Submit them to the relevant specialized package
  • General Support? Visit https://sharpapi.com/documentation

📜 Old Documentation (For Reference Only)

Click to expand old documentation (for existing users)

Installation

composer require sharpapi/sharpapi-php-client

Requirements

  • PHP >= 8.1

Basic Usage

$sharpApi = new \SharpAPI\SharpApiService\SharpApiService(SHARP_API_KEY);
$statusUrl = $sharpApi->summarizeText($text, 'English');
$result = $sharpApi->fetchResults($statusUrl);
var_dump($result->getResultJson());

For complete documentation, please refer to the specialized packages listed above.


License

The MIT License (MIT). Please see License File for more information.


Thank you for using SharpAPI! Please migrate to our new specialized packages for the best experience.

SharpAPI

About

Automate with AI-powered API. Leverage AI API for workflows automation in E-Commerce, Marketing, Content Management, HR Tech, Travel, and more.

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages