PHPackages                             ameax/ameax-json-import-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. ameax/ameax-json-import-api

ActiveLibrary[API Development](/categories/api)

ameax/ameax-json-import-api
===========================

A PHP package for sending data to Ameax via their JSON API

v1.0.2(10mo ago)021[1 PRs](https://github.com/ameax/ameax-json-import-api/pulls)MITPHPPHP ^8.2CI passing

Since May 13Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/ameax/ameax-json-import-api)[ Packagist](https://packagist.org/packages/ameax/ameax-json-import-api)[ Docs](https://github.com/ameax/ameax-json-import-api)[ GitHub Sponsors]()[ RSS](/packages/ameax-ameax-json-import-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (8)Versions (9)Used By (0)

Ameax JSON Import API
=====================

[](#ameax-json-import-api)

[![Latest Version on Packagist](https://camo.githubusercontent.com/354fe30f1bc76e278bb8972da24b9537458b1c76266faff005c04d34b063eeaf/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f616d6561782f616d6561782d6a736f6e2d696d706f72742d6170692e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ameax/ameax-json-import-api)[![GitHub Tests Action Status](https://camo.githubusercontent.com/75debffaa06ef5eac7df010f96d94209207b46fa996c9db2ba1fbbd33db8262c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f616d6561782f616d6561782d6a736f6e2d696d706f72742d6170692f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/ameax/ameax-json-import-api/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/ba1e665517762962108e4d3ada1ea19b9750e1f7b2191c2a63b5b7ac8e410706/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f616d6561782f616d6561782d6a736f6e2d696d706f72742d6170692f6669782d7068702d636f64652d7374796c652d6973737565732e796d6c3f6272616e63683d6d61696e266c6162656c3d636f64652532307374796c65267374796c653d666c61742d737175617265)](https://github.com/ameax/ameax-json-import-api/actions?query=workflow%3A%22Fix+PHP+code+style+issues%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/9624a9280d967d6c32b5468a7a6c6ceb309f92856bcc02bee5d57b3a610fd875/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f616d6561782f616d6561782d6a736f6e2d696d706f72742d6170692e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ameax/ameax-json-import-api)

A framework-agnostic PHP package for sending data to Ameax via their JSON API. This package provides an easy way to create and send organization, private person, receipt, and sales opportunity data to the Ameax API, with built-in validation according to the JSON schema v1.0.

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require ameax/ameax-json-import-api
```

Basic Usage
-----------

[](#basic-usage)

### Working with Organizations

[](#working-with-organizations)

```
use Ameax\AmeaxJsonImportApi\AmeaxJsonImportApi;

// Initialize the client
$client = new AmeaxJsonImportApi(
    'your-api-key',
    'https://your-database.ameax.de'
);

// Create an organization with fluent setters
$organization = $client->createOrganization();

// Add organization details using fluent setters
$organization
    ->setName('ACME Corporation')
    // Set required identifiers
    ->createIdentifiers('CUST12345')
    // Create address (required)
    ->createAddress('12345', 'Berlin', 'DE')
    ->setStreet('Main Street')
    // Set communication details
    ->setEmail('info@acme-corp.com')
    ->setPhone('+49 30 123456789');

// Add a contact
$organization->addContact(
    'John',
    'Doe',
    ['email' => 'john.doe@example.com']
);

// Send to Ameax API
try {
    $response = $organization->sendToAmeax();
    echo "Success!";
} catch (\Exception $e) {
    echo "Error: " . $e->getMessage();
}
```

### Working with Private Persons

[](#working-with-private-persons)

```
use Ameax\AmeaxJsonImportApi\AmeaxJsonImportApi;

// Initialize the client
$client = new AmeaxJsonImportApi(
    'your-api-key',
    'https://your-database.ameax.de'
);

// Create a private person with fluent setters
$privatePerson = $client->createPrivatePerson();

// Add private person details using fluent setters
$privatePerson
    ->setFirstName('John')
    ->setLastName('Doe')
    // Create address (required)
    ->createAddress('12345', 'Berlin', 'DE')
    ->setStreet('Main Street')
    // Set communication details
    ->setEmail('john.doe@example.com')
    ->setPhone('+49 30 123456789');

// Send to Ameax API
try {
    $response = $privatePerson->sendToAmeax();
    echo "Success!";
} catch (\Exception $e) {
    echo "Error: " . $e->getMessage();
}
```

### Working with Receipts (Invoices, Orders, etc.)

[](#working-with-receipts-invoices-orders-etc)

```
use Ameax\AmeaxJsonImportApi\AmeaxJsonImportApi;
use Ameax\AmeaxJsonImportApi\Models\Receipt;
use Ameax\AmeaxJsonImportApi\Models\LineItem;
use Ameax\AmeaxJsonImportApi\Models\DocumentPdf;

// Initialize the client
$client = new AmeaxJsonImportApi(
    'your-api-key',
    'https://your-database.ameax.de'
);

// Create a receipt (invoice)
$receipt = $client->createReceipt();

$receipt
    ->setType(Receipt::TYPE_INVOICE)
    ->setReceiptNumber('INV-2025-001')
    ->setCustomerNumber('CUST12345')
    ->setDate('2025-06-01')
    ->setStatus(Receipt::STATUS_PENDING)
    ->setTaxMode(Receipt::TAX_MODE_NET)
    ->setTaxType(Receipt::TAX_TYPE_REGULAR);

// Add line items
$lineItem = new LineItem();
$lineItem
    ->setDescription('Product A')
    ->setQuantity(2)
    ->setPrice(100.00)
    ->setTaxRate(19)
    ->setTaxType(LineItem::TAX_TYPE_REGULAR)
    ->setUom('pcs'); // Unit of measurement (optional)

$receipt->addLineItem($lineItem);

// Add PDF document attachment (optional)
// Option 1: From base64 encoded content
$receipt->setDocumentPdfFromBase64($base64PdfContent);

// Option 2: From URL
$receipt->setDocumentPdfFromUrl('https://example.com/invoice.pdf');

// Option 3: Using DocumentPdf object
$pdf = DocumentPdf::fromBase64($base64PdfContent);
$receipt->setDocumentPdf($pdf);

// Send to Ameax API
try {
    $response = $receipt->sendToAmeax();
    echo "Receipt created successfully!";
} catch (\Exception $e) {
    echo "Error: " . $e->getMessage();
}
```

### Working with Sales Opportunities

[](#working-with-sales-opportunities)

```
use Ameax\AmeaxJsonImportApi\AmeaxJsonImportApi;
use Ameax\AmeaxJsonImportApi\Models\Sale;
use Ameax\AmeaxJsonImportApi\Models\Rating;

// Initialize the client
$client = new AmeaxJsonImportApi(
    'your-api-key',
    'https://your-database.ameax.de'
);

// Create a sales opportunity
$sale = $client->createSale();

$sale
    ->setExternalId('OPP-2025-001')
    ->setCustomerNumber('CUST12345')
    ->setSubject('New Software Implementation')
    ->setSaleStatus(Sale::STATUS_ACTIVE)
    ->setSellingStatus(Sale::SELLING_STATUS_QUALIFICATION)
    ->setUserExternalId('USER123')
    ->setDate('2025-06-01')
    ->setAmount(50000.00)
    ->setProbability(75)
    ->setCloseDate('2025-07-01');

// Add rating (optional)
$rating = $sale->createRating();
$rating
    ->setRelationship(6, Rating::SOURCE_KNOWN)
    ->setProposition(5, Rating::SOURCE_ASSUMED)
    ->setTrust(7, Rating::SOURCE_KNOWN)
    ->setCompetition(4, Rating::SOURCE_GUESSED)
    ->setNeedForAction(6, Rating::SOURCE_KNOWN)
    ->setBuyingProcess(5, Rating::SOURCE_ASSUMED)
    ->setPrice(5, Rating::SOURCE_KNOWN);

// Send to Ameax API
try {
    $response = $sale->sendToAmeax();
    echo "Sales opportunity created successfully!";
} catch (\Exception $e) {
    echo "Error: " . $e->getMessage();
}
```

Data Structure
--------------

[](#data-structure)

This package follows the Ameax JSON schema structure:

### Organization

[](#organization)

The organization structure includes multiple nested objects:

```
[
    'meta' => [
        'document_type' => 'ameax_organization_account',
        'schema_version' => '1.0'
    ],
    'name' => 'ACME Corporation',
    'additional_name' => 'ACME Corp.',
    'identifiers' => [
        'customer_number' => 'CUST12345',
        'external_id' => 'EXT98765',
        'ameax_internal_id' => 123456  // Set by API, read-only
    ],
    'address' => [
        'route' => 'Main Street',
        'house_number' => '123',
        'postal_code' => '12345',
        'locality' => 'Berlin',
        'country' => 'DE'
    ],
    'social_media' => [
        'web' => 'https://www.acme-corp.com'
    ],
    'communications' => [
        'phone_number' => '+49 30 123456789',
        'mobile_phone' => '+49 151 123456789',
        'email' => 'info@acme-corp.com',
        'fax' => '+49 30 987654321'
    ],
    'business_information' => [
        'vat_id' => 'DE123456789',
        'iban' => 'DE89370400440532013000'
    ],
    'agent' => [
        'external_id' => 'AGENT123'
    ],
    'custom_data' => [
        'industry' => 'Technology',
        'employees' => 500
    ],
    'contacts' => [/* Array of contact objects */]
]
```

### Private Person

[](#private-person)

The private person structure is similar to the organization but without contacts:

```
[
    'meta' => [
        'document_type' => 'ameax_private_person_account',
        'schema_version' => '1.0'
    ],
    'salutation' => 'Mr.',
    'honorifics' => 'Dr.',
    'firstname' => 'John',
    'lastname' => 'Doe',
    'date_of_birth' => '1980-01-01',
    'identifiers' => [
        'customer_number' => 'CUST12345',
        'external_id' => 'EXT-PP-001',
        'ameax_internal_id' => 654321  // Set by API, read-only
    ],
    'address' => [
        'route' => 'Main Street',
        'house_number' => '123',
        'postal_code' => '12345',
        'locality' => 'Berlin',
        'country' => 'DE'
    ],
    'communications' => [
        'phone_number' => '+49 30 123456789',
        'mobile_phone' => '+49 151 123456789',
        'email' => 'john.doe@example.com',
        'fax' => '+49 30 987654321'
    ],
    'agent' => [
        'external_id' => 'AGENT123'
    ],
    'custom_data' => [
        'preferred_language' => 'en',
        'newsletter_subscription' => true
    ]
]
```

### Contact

[](#contact)

Contacts have a similar nested structure:

```
[
    'salutation' => 'Mr.',
    'honorifics' => 'Dr.',
    'firstname' => 'John',
    'lastname' => 'Doe',
    'date_of_birth' => '1980-01-01',
    'identifiers' => [
        'external_id' => 'EMP123'
    ],
    'employment' => [
        'job_title' => 'CEO',
        'department' => 'Management'
    ],
    'communications' => [
        'phone_number' => '+49 30 123456789',
        'mobile_phone' => '+49 151 123456789',
        'email' => 'john.doe@example.com',
        'fax' => '+49 30 987654321'
    ],
    'custom_data' => [
        'language' => 'en',
        'timezone' => 'Europe/Berlin'
    ]
]
```

### Receipt

[](#receipt)

Receipts represent invoices, orders, offers, credit notes, and cancellation documents:

```
[
    'meta' => [
        'document_type' => 'ameax_receipt',
        'schema_version' => '1.0'
    ],
    'type' => 'invoice',
    'identifiers' => [
        'receipt_number' => 'INV-2025-001',
        'external_id' => 'EXT-INV-001',
        'ameax_internal_id' => 12345
    ],
    'business_id' => 1,
    'user_external_id' => 'USER123',
    'sale_external_id' => 'OPP-2025-001',
    'date' => '2025-06-01',
    'customer_number' => 'CUST12345',
    'status' => 'pending',
    'tax_mode' => 'net',
    'tax_type' => 'regular',
    'subject' => 'Invoice for Services',
    'line_items' => [
        [
            'article_number' => 'ART001',
            'description' => 'Consulting Services',
            'quantity' => 10,
            'price' => 150.00,
            'tax_rate' => 19,
            'tax_type' => 'regular',
            'uom' => 'hours'  // Unit of measurement (optional)
        ]
    ],
    'document_pdf' => [
        'type' => 'base64',
        'content' => 'JVBERi0xLjQK...' // base64 encoded PDF content
        // OR use URL mode:
        // 'type' => 'url',
        // 'url' => 'https://example.com/invoice.pdf'
    ],
    'custom_data' => [
        'payment_terms' => '30 days net'
    ]
]
```

### Sale

[](#sale)

Sales represent opportunities in the sales pipeline:

```
[
    'meta' => [
        'document_type' => 'ameax_sale',
        'schema_version' => '1.0'
    ],
    'identifiers' => [
        'external_id' => 'OPP-2025-001',
        'ameax_internal_id' => 54321
    ],
    'customer' => [
        'customer_number' => 'CUST12345'
    ],
    'subject' => 'New Software Implementation',
    'description' => 'Implementation of ERP system',
    'sale_status' => 'active',
    'selling_status' => 'qualification',
    'user_external_id' => 'USER123',
    'date' => '2025-06-01',
    'amount' => 50000.00,
    'probability' => 75,
    'close_date' => '2025-07-01',
    'rating' => [
        'relationship' => ['rating' => 6, 'source' => 'known'],
        'proposition' => ['rating' => 5, 'source' => 'assumed'],
        'trust' => ['rating' => 7, 'source' => 'known'],
        'competition' => ['rating' => 4, 'source' => 'guessed'],
        'need_for_action' => ['rating' => 6, 'source' => 'known'],
        'buying_process' => ['rating' => 5, 'source' => 'assumed'],
        'price' => ['rating' => 5, 'source' => 'known']
    ],
    'custom_data' => [
        'lead_source' => 'website',
        'campaign' => 'Q2-2025'
    ]
]
```

Complete Examples
-----------------

[](#complete-examples)

### Organization Example

[](#organization-example)

Here's a comprehensive example using all available features for organizations:

```
use Ameax\AmeaxJsonImportApi\AmeaxJsonImportApi;
use Ameax\AmeaxJsonImportApi\Exceptions\ValidationException;

// Create the API client
$client = new AmeaxJsonImportApi('your-api-key', 'https://your-database.ameax.de');

try {
    // Create a new organization
    $organization = $client->createOrganization();

    // Set basic information
    $organization->setName('ACME Corporation')
                 ->setAdditionalName('ACME Corp.');

    // Set identifiers (required)
    $organization->createIdentifiers('CUST12345', 'EXT98765');

    // Create address (required)
    $organization->createAddress('12345', 'Berlin', 'DE')
                 ->setRoute('Example Street')
                 ->setHouseNumber('42');

    // Set social media
    $organization->setWebsite('https://www.example.com');

    // Set communications
    $organization->createCommunications(
        'info@example.com',          // email
        '+49 30 123456789',          // phone
        '+49 151 123456789',         // mobile
        '+49 30 987654321'           // fax
    );

    // Set business information
    $organization->createBusinessInformation(
        'DE123456789',               // VAT ID
        'DE89370400440532013000'     // IBAN
    );

    // Set agent
    $organization->createAgent('AGENT123');

    // Set custom data
    $organization->setCustomData([
        'industry' => 'Technology',
        'employees' => 500
    ]);

    // Create and add a contact with full details
    $contact = $client->createContact();
    $contact->setSalutation('Mr.')
            ->setHonorifics('Dr.')
            ->setFirstName('John')
            ->setLastName('Doe')
            ->setDateOfBirth('1980-01-01');

    // Set contact identifiers
    $contact->createIdentifiers('EMP123');

    // Set contact employment
    $contact->createEmployment('CEO', 'Management');

    // Set contact communications
    $contact->createCommunications(
        'john.doe@example.com',      // email
        '+49 30 123456789',          // phone
        '+49 151 123456789',         // mobile
        '+49 30 987654321'           // fax
    );

    // Add the contact to the organization
    $organization->addContactObject($contact);

    // Send to Ameax API
    $response = $organization->sendToAmeax();

} catch (ValidationException $e) {
    // Handle validation errors
    print_r($e->getErrors());
} catch (\Exception $e) {
    // Handle other errors
    echo $e->getMessage();
}
```

### Private Person Example

[](#private-person-example)

Here's a complete example for creating and sending private person data:

```
use Ameax\AmeaxJsonImportApi\AmeaxJsonImportApi;
use Ameax\AmeaxJsonImportApi\Exceptions\ValidationException;
use Ameax\AmeaxJsonImportApi\Models\Meta;

// Create the API client
$client = new AmeaxJsonImportApi('your-api-key', 'https://your-database.ameax.de');

try {
    // Create a new private person
    $privatePerson = $client->createPrivatePerson();

    // Set basic personal information
    $privatePerson->setSalutation('Mr.')
                  ->setHonorifics('Dr.')
                  ->setFirstName('John')
                  ->setLastName('Doe')
                  ->setDateOfBirth('1980-01-01');

    // Set identifiers
    $privatePerson->createIdentifiers('CUST12345');

    // Create address (required)
    $privatePerson->createAddress('12345', 'Berlin', 'DE')
                  ->setStreet('Example Street')
                  ->setHouseNumber('42');

    // Set communications
    $privatePerson->createCommunications(
        'john.doe@example.com',          // email
        '+49 30 123456789',              // phone
        '+49 151 123456789',             // mobile
        '+49 30 987654321'               // fax
    );

    // Set agent
    $privatePerson->createAgent('AGENT123');

    // Set custom data
    $privatePerson->setCustomData([
        'preferred_language' => 'en',
        'newsletter_subscription' => true
    ]);

    // Send to Ameax API
    $response = $privatePerson->sendToAmeax();

} catch (ValidationException $e) {
    // Handle validation errors
    print_r($e->getErrors());
} catch (\Exception $e) {
    // Handle other errors
    echo $e->getMessage();
}
```

### Creating from Existing Data

[](#creating-from-existing-data)

You can create objects from existing data when you already have all the data structured as an array.

#### Organization from Array

[](#organization-from-array)

```
// Complete organization data structure
$data = [
    'meta' => [
        'document_type' => 'ameax_organization_account',
        'schema_version' => '1.0'
    ],
    'name' => 'XYZ Ltd',
    'additional_name' => 'XYZ Limited',
    'identifiers' => [
        'customer_number' => 'CUST54321',
        'external_id' => 'EXT12345'
    ],
    'address' => [
        'route' => 'Main Street',
        'house_number' => '42',
        'postal_code' => '54321',
        'locality' => 'Munich',
        'country' => 'DE',
    ],
    'communications' => [
        'email' => 'info@xyz-ltd.com',
        'phone_number' => '+49 89 123456789'
    ],
    'social_media' => [
        'web' => 'https://www.xyz-ltd.com'
    ],
    'business_information' => [
        'vat_id' => 'DE123456789'
    ],
    'contacts' => [
        [
            'firstname' => 'Jane',
            'lastname' => 'Smith',
            'communications' => [
                'email' => 'jane.smith@xyz-ltd.com'
            ],
            'employment' => [
                'job_title' => 'CEO'
            ]
        ]
    ],
    'custom_data' => [
        'industry' => 'Manufacturing'
    ]
];

// Create the organization from the array
$organization = $client->organizationFromArray($data);

// Optionally modify some fields
$organization->setEmail('new-email@xyz-ltd.com');

// Send to Ameax API
$response = $organization->sendToAmeax();
```

#### Private Person from Array

[](#private-person-from-array)

```
// Complete private person data structure
$data = [
    'meta' => [
        'document_type' => 'ameax_private_person_account',
        'schema_version' => '1.0'
    ],
    'salutation' => 'Ms.',
    'firstname' => 'Jane',
    'lastname' => 'Doe',
    'date_of_birth' => '1985-05-15',
    'identifiers' => [
        'customer_number' => 'CUST67890'
    ],
    'address' => [
        'route' => 'Example Road',
        'house_number' => '42',
        'postal_code' => '54321',
        'locality' => 'Munich',
        'country' => 'DE',
    ],
    'communications' => [
        'email' => 'jane.doe@example.com',
        'phone_number' => '+49 89 123456789'
    ],
    'custom_data' => [
        'preferred_language' => 'en',
        'newsletter_subscription' => true
    ]
];

// Create the private person from the array
$privatePerson = $client->privatePersonFromArray($data);

// Optionally modify some fields
$privatePerson->setEmail('new-email@example.com');

// Send to Ameax API
$response = $privatePerson->sendToAmeax();
```

You can also create objects with partial data and disable immediate validation:

```
// Only provide required fields
$minimalData = [
    'firstname' => 'Jane',
    'lastname' => 'Doe',
    'address' => [
        'postal_code' => '54321',
        'locality' => 'Munich',
        'country' => 'DE',
    ],
];

// Pass false to disable immediate validation
$privatePerson = $client->privatePersonFromArray($minimalData, false);

// Fill in more data before validation
$privatePerson->setEmail('jane.doe@example.com')
             ->setCustomerNumber('CUST67890');

// Manually validate when ready
$privatePerson->validate();

// Send to Ameax API
$response = $privatePerson->sendToAmeax();
```

JSON Schema Validation
----------------------

[](#json-schema-validation)

This package validates your data against the Ameax JSON schema before sending it to the API. The validation uses the official Ameax JSON schemas to ensure your data is valid. The package performs validation at multiple levels:

1. **Field-level validation**: Each setter method validates individual fields (e.g., email format, phone number format).
2. **Model-level validation**: The `validate()` method checks required fields and relationships.
3. **Schema-level validation**: Before sending data to the API, it validates against the official Ameax JSON schema.

### Custom Schemas

[](#custom-schemas)

You can use your own schemas by specifying the schemas path using the fluent setter:

```
$client = new AmeaxJsonImportApi(
    'your-api-key',
    'https://your-database.ameax.de'
);

$client->setSchemasPath('/path/to/your/schemas');
```

### Schema Validation

[](#schema-validation)

The package provides built-in JSON Schema validation using the `SchemaValidator` class:

```
use Ameax\AmeaxJsonImportApi\Validation\SchemaValidator;

// Validate data against a schema file
$data = $organization->toArray();
$schemaPath = '/path/to/schemas/ameax_organization_account.json';
SchemaValidator::validate($data, $schemaPath);

// Or validate against a schema string
$schemaJson = file_get_contents($schemaPath);
SchemaValidator::validateWithString($data, $schemaJson);
```

Documentation
-------------

[](#documentation)

For more detailed documentation, see the [docs](docs) directory:

- [Installation](docs/installation.md)
- [Organization API](docs/organizations.md)
- [API Reference](docs/api-reference.md)

Testing
-------

[](#testing)

```
composer test
```

Versioning
----------

[](#versioning)

This package follows [Semantic Versioning](https://semver.org/). The version numbers follow the `MAJOR.MINOR.PATCH` format:

- **MAJOR** version increases when incompatible API changes are made
- **MINOR** version increases when functionality is added in a backward-compatible manner
- **PATCH** version increases when backward-compatible bug fixes are implemented

Use the appropriate version constraint in your composer.json:

```
"require": {
    "ameax/ameax-json-import-api": "^1.0"
}
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Michael Schmidt](https://github.com/69188126+ms-aranes)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

39

—

LowBetter than 86% of packages

Maintenance75

Regular maintenance activity

Popularity7

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 71.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~32 days

Total

3

Last Release

306d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/f67be86f330b5a3e644c8594bbf322be6ab1a08da5434d9cef417097d5567287?d=identicon)[aranes](/maintainers/aranes)

---

Top Contributors

[![ms-aranes](https://avatars.githubusercontent.com/u/69188126?v=4)](https://github.com/ms-aranes "ms-aranes (54 commits)")[![Inoqulath](https://avatars.githubusercontent.com/u/104569371?v=4)](https://github.com/Inoqulath "Inoqulath (12 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (8 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (2 commits)")

---

Tags

phpjsonapiAmeaxameax-json-import-api

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/ameax-ameax-json-import-api/health.svg)

```
[![Health](https://phpackages.com/badges/ameax-ameax-json-import-api/health.svg)](https://phpackages.com/packages/ameax-ameax-json-import-api)
```

###  Alternatives

[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k7.6M74](/packages/openai-php-laravel)[php-opencloud/openstack

PHP SDK for OpenStack APIs. Supports BlockStorage, Compute, Identity, Images, Networking and Metric Gnocchi

2292.2M24](/packages/php-opencloud-openstack)[theodo-group/llphant

LLPhant is a library to help you build Generative AI applications.

1.5k311.5k5](/packages/theodo-group-llphant)[resend/resend-php

Resend PHP library.

564.7M21](/packages/resend-resend-php)[obiefy/api-response

Simple Laravel package to return Json responses.

17324.6k](/packages/obiefy-api-response)[facturama/facturama-php-sdk

Facturama PHP SDK

1194.9k1](/packages/facturama-facturama-php-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)