{"id":16255560,"url":"https://github.com/grena/oxatis-api-php-client","last_synced_at":"2025-04-08T13:19:53.731Z","repository":{"id":48853463,"uuid":"379219286","full_name":"grena/oxatis-api-php-client","owner":"grena","description":"PHP client for Oxatis SOAP API","archived":false,"fork":false,"pushed_at":"2023-09-19T08:40:25.000Z","size":635,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-04T00:38:50.139Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grena.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-22T09:49:29.000Z","updated_at":"2021-07-08T15:02:56.000Z","dependencies_parsed_at":"2024-11-04T19:40:54.654Z","dependency_job_id":"b16063d3-41b4-427b-a241-6dfdb0862e14","html_url":"https://github.com/grena/oxatis-api-php-client","commit_stats":{"total_commits":18,"total_committers":2,"mean_commits":9.0,"dds":"0.16666666666666663","last_synced_commit":"d9158b01619fa64ad9a9fc3f5eb2fbab2f2cfb29"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grena%2Foxatis-api-php-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grena%2Foxatis-api-php-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grena%2Foxatis-api-php-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grena%2Foxatis-api-php-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grena","download_url":"https://codeload.github.com/grena/oxatis-api-php-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247847611,"owners_count":21006100,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T15:43:22.564Z","updated_at":"2025-04-08T13:19:53.714Z","avatar_url":"https://github.com/grena.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Oxatis API - PHP Client\n\nThis is a PHP API Client for any [Oxatis](https://www.oxatis.com/) SaaS instance.\n\n[![Build Status](https://travis-ci.com/grena/oxatis-api-php-client.svg?branch=main)](https://travis-ci.com/grena/oxatis-api-php-client)\n\n## Requirements\n- PHP \u003e= 7.4\n- Composer\n\n\n## Install\n\n```bash\ncomposer require grena/oxatis-api-php-client\n```\n\n## How to use\n\nIn your project, import the `OxatisClientBuilder` and build a client with your Oxatis AppID and token:\n```php\nuse Heavymind\\Oxatis\\ApiClient\\OxatisClientBuilder;\n\n// Build the Oxatis client with your AppID and Token\n$clientBuilder = new OxatisClientBuilder();\n$oxatisClient = $clientBuilder-\u003ebuildAuthenticatedByToken(\n    \"OXATIS_APP_ID\", \n    \"OXATIS_TOKEN\"\n);\n```\n\nNow you can use the `OxatisClient` to make requests, for example here, retrieving \"Country names\" for each tax rate:\n\n```php\nuse Heavymind\\Oxatis\\ApiClient\\Type\\TaxRateGetList;\nuse Heavymind\\Oxatis\\ApiClient\\Type\\TaxRateEntity;\n\n$response = $oxatisClient-\u003egetTaxRateServices()-\u003etaxRateGetList(\n    new TaxRateGetList($oxatisClient-\u003egetWSIdentitySoap())\n);\n\nforeach ($response-\u003egetDataResultService()-\u003egetData()-\u003egetTaxRateList()-\u003egetTaxRateIDs() as $taxRateID)\n{\n    /** @var TaxRateEntity $taxRateID */\n    var_dump($taxRateID-\u003egetCountryName());\n}\n```\n\n## Regenerate the API\n\nThis API is mainly auto-generated thanks to `phpro/soap-client`.\n\nIf the online Soap WSDL files changed on Oxatis side, this API Client **needs to be regenerated** by running:\n```bash\ndocker-compose run php_74 php generate-soap-api.php\n```\n\nThis will:\n- Generate the needed config files for `phpro/soap-client` in the `config/` folder\n- Generate each Type class for each service in `src/Type`\n- Generate client and client factory for each service in `src/Services/`\n\n## Contribute\n\nClone this project, then:\n\n```bash\ncp docker-compose.yml.dist docker-compose.yml\ndocker-compose up --build\ndocker-compose run php_74 ./composer.phar install\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrena%2Foxatis-api-php-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrena%2Foxatis-api-php-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrena%2Foxatis-api-php-client/lists"}