{"id":19703467,"url":"https://github.com/crowdin/crowdin-api-client-php","last_synced_at":"2025-04-08T13:07:27.995Z","repository":{"id":36321855,"uuid":"214450641","full_name":"crowdin/crowdin-api-client-php","owner":"crowdin","description":"PHP client library for Crowdin API","archived":false,"fork":false,"pushed_at":"2025-03-28T16:07:34.000Z","size":1927,"stargazers_count":59,"open_issues_count":17,"forks_count":33,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-02T22:34:00.169Z","etag":null,"topics":["api","client","crowdin-api","hacktoberfest","php","sdk"],"latest_commit_sha":null,"homepage":"https://packagist.org/packages/crowdin/crowdin-api-client","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/crowdin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2019-10-11T13:59:40.000Z","updated_at":"2025-03-28T16:06:45.000Z","dependencies_parsed_at":"2024-12-30T03:03:44.850Z","dependency_job_id":"ea98a2ad-8f54-4fc3-9746-3cc49cc8b9b3","html_url":"https://github.com/crowdin/crowdin-api-client-php","commit_stats":{"total_commits":208,"total_committers":17,"mean_commits":"12.235294117647058","dds":0.75,"last_synced_commit":"a0d1b47dc8bb5405cd3d0f707f6d34bac95428a4"},"previous_names":[],"tags_count":48,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowdin%2Fcrowdin-api-client-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowdin%2Fcrowdin-api-client-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowdin%2Fcrowdin-api-client-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crowdin%2Fcrowdin-api-client-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crowdin","download_url":"https://codeload.github.com/crowdin/crowdin-api-client-php/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247847610,"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":["api","client","crowdin-api","hacktoberfest","php","sdk"],"created_at":"2024-11-11T21:17:58.329Z","updated_at":"2025-04-08T13:07:27.966Z","avatar_url":"https://github.com/crowdin.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://support.crowdin.com/assets/logos/symbol/png/crowdin-symbol-cWhite.png\"\u003e\n    \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://support.crowdin.com/assets/logos/symbol/png/crowdin-symbol-cDark.png\"\u003e\n    \u003cimg width=\"150\" height=\"150\" src=\"https://support.crowdin.com/assets/logos/symbol/png/crowdin-symbol-cDark.png\"\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n\n# Crowdin PHP client\n\nThe Crowdin PHP client is a lightweight interface to the Crowdin API. It provides common services for making API requests.\n\nOur API is a full-featured RESTful API that helps you to integrate localization into your development process. The endpoints that we use allow you to easily make calls to retrieve information and to execute actions needed.\n\n\u003cdiv align=\"center\"\u003e\n\n[**`API Client Docs`**](https://crowdin.github.io/crowdin-api-client-php/packages/Crowdin.html) \u0026nbsp;|\u0026nbsp;\n[**`Examples`**](https://github.com/crowdin/crowdin-api-client-php/blob/master/EXAMPLES.md) \u0026nbsp;|\u0026nbsp;\n[**`Crowdin API`**](https://developer.crowdin.com/api/v2/) \u0026nbsp;|\u0026nbsp;\n[**`Crowdin Enterprise API`**](https://developer.crowdin.com/enterprise/api/v2/)\n\n[![Packagist Version](https://img.shields.io/packagist/v/crowdin/crowdin-api-client?cacheSeconds=3600)](https://packagist.org/packages/crowdin/crowdin-api-client)\n[![Packagist](https://img.shields.io/packagist/dt/crowdin/crowdin-api-client?cacheSeconds=3600)](https://packagist.org/packages/crowdin/crowdin-api-client)\n[![Tests](https://github.com/crowdin/crowdin-api-client-php/actions/workflows/basic.yml/badge.svg)](https://github.com/crowdin/crowdin-api-client-php/actions/workflows/basic.yml)\n[![codecov](https://codecov.io/gh/crowdin/crowdin-api-client-php/branch/master/graph/badge.svg)](https://codecov.io/gh/crowdin/crowdin-api-client-php)\n[![GitHub contributors](https://img.shields.io/github/contributors/crowdin/crowdin-api-client-php?cacheSeconds=3600)](https://github.com/crowdin/crowdin-api-client-php/graphs/contributors)\n[![GitHub](https://img.shields.io/github/license/crowdin/crowdin-api-client-php?cacheSeconds=3600)](https://github.com/crowdin/crowdin-api-client-php/blob/master/LICENSE)\n\n\u003c/div\u003e\n\n### Requirements\n\n* PHP \u003e= 7.1\n\n## Installation\n\nInstall via Composer\n\n```console\ncomposer require crowdin/crowdin-api-client\n```\n\n### Quick Start\n\nThe API client must be instantiated and configured before calling any API method.\n\n```php\nuse CrowdinApiClient\\Crowdin;\n\n$crowdin = new Crowdin([\n    'access_token' =\u003e '\u003caccess_token\u003e',\n    'organization' =\u003e '\u003corganization_domain\u003e', // optional\n]);\n```\n\n`\u003caccess_token\u003e` - Personal Access Token. You can generate Personal Access Token in your Crowdin Account Settings.\n\n`\u003corganization_domain\u003e` - Organization domain name (for Crowdin Enterprise users only).\n\nFor more about Authorization see the [documentation](https://developer.crowdin.com/api/v2/#section/Introduction/Authorization).\n\n#### REST API Examples\n\n* Create directory\n    ```php\n    $directory = $crowdin-\u003edirectory-\u003ecreate(\n        \u003cproject_id\u003e,\n        ['name'=\u003e 'My Directory']\n    );\n    ```\n\n* Edit directory\n    ```php\n    $directory-\u003esetTitle('My Title');\n\n    $crowdin-\u003edirectory-\u003eupdate($directory);\n    ```\n\n* Delete directory\n    ```php\n    $crowdin-\u003edirectory-\u003edelete($directory-\u003egetProjectId(), $directory-\u003egetId());\n    ```\n\n#### GraphQL API Example\n\nFor more information about GraphQL API see the [documentation](https://support.crowdin.com/developer/graphql-api/).\n\n```php\n$query = 'query($limit: Int) {\n  viewer {\n    projects(first: $limit) {\n      edges {\n        node {\n          name\n          files(first: $limit) {\n            totalCount\n            edges {\n              node {\n                name\n                type\n              }\n            }\n          }\n        }\n      }\n    }\n  }\n}';\n\n$response = $crowdin-\u003egraphql-\u003equery($query, null, ['limit' =\u003e 10]);\n```\n\n## Seeking Assistance\n\nIf you find any problems or would like to suggest a feature, please read the [How can I contribute](/CONTRIBUTING.md#how-can-i-contribute) section in our contributing guidelines.\n\n## Contributing\n\nIf you would like to contribute, please read the [Contributing Guidelines](/CONTRIBUTING.md).\n\n### License\n\n\u003cpre\u003e\nThe Crowdin PHP client is licensed under the MIT License.\nSee the LICENSE file distributed with this work for additional\ninformation regarding copyright ownership.\n\nExcept as contained in the LICENSE file, the name(s) of the above copyright\nholders shall not be used in advertising or otherwise to promote the sale,\nuse or other dealings in this Software without prior written authorization.\n\u003c/pre\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowdin%2Fcrowdin-api-client-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrowdin%2Fcrowdin-api-client-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrowdin%2Fcrowdin-api-client-php/lists"}