{"id":25839786,"url":"https://github.com/netresearch/deutschepost-sdk-addressfactory","last_synced_at":"2025-03-01T04:34:26.256Z","repository":{"id":53520795,"uuid":"272940469","full_name":"netresearch/deutschepost-sdk-addressfactory","owner":"netresearch","description":"The Postdirekt Addressfactory API SDK package offers an interface to the ADDRESSFACTORY DIRECT web service which allows to correct and enrich address datasets.","archived":false,"fork":false,"pushed_at":"2023-12-15T13:24:21.000Z","size":169,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-04-14T11:16:22.020Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netresearch.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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":"2020-06-17T10:05:13.000Z","updated_at":"2023-07-13T12:46:45.000Z","dependencies_parsed_at":"2025-02-18T13:26:53.727Z","dependency_job_id":"f7b03750-5034-4f81-9b68-a1f55de3c3b8","html_url":"https://github.com/netresearch/deutschepost-sdk-addressfactory","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdeutschepost-sdk-addressfactory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdeutschepost-sdk-addressfactory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdeutschepost-sdk-addressfactory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdeutschepost-sdk-addressfactory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netresearch","download_url":"https://codeload.github.com/netresearch/deutschepost-sdk-addressfactory/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241317608,"owners_count":19943199,"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":"2025-03-01T04:34:25.458Z","updated_at":"2025-03-01T04:34:26.250Z","avatar_url":"https://github.com/netresearch.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Postdirekt Addressfactory API SDK\n\nThe Postdirekt Addressfactory API SDK package offers an interface to the\nADDRESSFACTORY DIRECT web service which allows to correct and enrich address datasets.\n\n## Requirements\n\n### System Requirements\n\n- PHP 8.1+ with SOAP extension\n\n### Package Requirements\n\n- `psr/log`: PSR-3 logger interfaces\n\n### Development Package Requirements\n\n- `phpstan/phpstan`: Static analysis tool\n- `phpunit/phpunit`: Testing framework\n- `squizlabs/php_codesniffer`: Static analysis tool\n- `rector/rector`: Refactoring tool\n- `fig/log-test`: Test utilities for `psr/log`\n\n## Installation\n\n```bash\ncomposer require deutschepost/sdk-api-addressfactory\n```\n\n## Uninstallation\n\n```bash\ncomposer remove deutschepost/sdk-api-addressfactory\n```\n\n## Testing\n\n```bash\ncomposer run test\n```\n\n## Features\n\nThe Postdirekt Addressfactory API SDK supports the following features:\n\n- Get address record by flat address data\n- Get address record(s) by complex address data\n\n### Get Record By Address\n\nVerify a single address record by passing name and street address.\n\n#### Public API\n\nThe library's components suitable for consumption comprise of\n\n- service:\n  - service factory\n  - address verification service\n- data transfer objects:\n  - response record with corrections and status codes indicating issues with the input data\n\n#### Usage\n\n```php\n$logger = new \\Psr\\Log\\NullLogger();\n$configName = 'default';\n\n$serviceFactory = new \\PostDirekt\\Sdk\\AddressfactoryDirect\\Service\\ServiceFactory();\n$service = $serviceFactory-\u003ecreateAddressVerificationService('user', 'pass', $logger);\n\n$record = $service-\u003egetRecordByAddress('53114', 'Bonn', 'Sträßchenweg', '10', 'Mustermann', 'Hans', null, $configName);\n\necho $record-\u003egetAddress()-\u003egetPostalCode(); // \"53113\"\necho $record-\u003egetAddress()-\u003egetStreetName(); // \"Sträßchensweg\"\necho $record-\u003egetStatusCodes(); // ['BAC100103', 'FNC400501', 'PDC030105', '…']\n```\n\n### Get Records By Complex Address\n\nVerify address records by passing in a complex request objects.\n\n#### Public API\n\nThe library's components suitable for consumption comprise of\n\n- service:\n  - service factory\n  - address verification service\n  - data transfer object builder\n- data transfer objects:\n  - response record with corrections and status codes indicating issues with the input data\n\n#### Usage\n\n```php\n$logger = new \\Psr\\Log\\NullLogger();\n$configName = 'default';\n\n$serviceFactory = new \\PostDirekt\\Sdk\\AddressfactoryDirect\\Service\\ServiceFactory();\n$service = $serviceFactory-\u003ecreateAddressVerificationService('user', 'pass', $logger);\n\n$requestBuilder = new \\PostDirekt\\Sdk\\AddressfactoryDirect\\RequestBuilder\\RequestBuilder();\n$requestBuilder-\u003esetMetadata($recordId = 1);\n$requestBuilder-\u003esetAddress('Deutschland', '53114', 'Bonn', 'Sträßchenweg', '10');\n$request = $requestBuilder-\u003ecreate();\n\n$records = $service-\u003egetRecords([$request], null, $configName);\nforeach ($records as $record) {\n    echo $record-\u003egetRecordId(); // 1\n    echo $record-\u003egetAddress()-\u003egetPostalCode(); // \"53113\"\n    echo $record-\u003egetAddress()-\u003egetStreetName(); // \"Sträßchensweg\"\n    echo $record-\u003egetStatusCodes(); // ['BAC100103', 'FNC400501', 'PDC030105', '…']\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetresearch%2Fdeutschepost-sdk-addressfactory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetresearch%2Fdeutschepost-sdk-addressfactory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetresearch%2Fdeutschepost-sdk-addressfactory/lists"}