{"id":20408510,"url":"https://github.com/prhost/mitryusweb-sdk-php","last_synced_at":"2025-09-24T04:31:11.744Z","repository":{"id":57044605,"uuid":"255193338","full_name":"prhost/mitryusweb-sdk-php","owner":"prhost","description":"SDK para facilitar a integração com a API da Mitryusweb","archived":false,"fork":false,"pushed_at":"2020-11-26T21:06:54.000Z","size":31,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-06T08:11:12.477Z","etag":null,"topics":["mitryuweb","php","sdk-php","vetor"],"latest_commit_sha":null,"homepage":"https://www.mitryus.com.br","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/prhost.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}},"created_at":"2020-04-13T00:06:16.000Z","updated_at":"2024-04-05T19:56:35.000Z","dependencies_parsed_at":"2022-08-24T04:11:19.222Z","dependency_job_id":null,"html_url":"https://github.com/prhost/mitryusweb-sdk-php","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/prhost/mitryusweb-sdk-php","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prhost%2Fmitryusweb-sdk-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prhost%2Fmitryusweb-sdk-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prhost%2Fmitryusweb-sdk-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prhost%2Fmitryusweb-sdk-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prhost","download_url":"https://codeload.github.com/prhost/mitryusweb-sdk-php/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prhost%2Fmitryusweb-sdk-php/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276694490,"owners_count":25687765,"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","status":"online","status_checked_at":"2025-09-24T02:00:09.776Z","response_time":97,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["mitryuweb","php","sdk-php","vetor"],"created_at":"2024-11-15T05:32:52.646Z","updated_at":"2025-09-24T04:31:11.403Z","avatar_url":"https://github.com/prhost.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SDK PHP para API Mitryusweb (Work in progress)\n\n### Documentação:\n\nhttps://www.mitryus.com.br:8191/MitryusReports/integracao.xhtml#metodoslayout\n\n### Requerimento:\n* PHP \u003e= 7.1\n* Json extension\n* Curl extension\n\n### Pacotes usados:\n\n* guzzlehttp/guzzle: ^6.3\n* nesbot/carbon: ^1.36\n* illuminate/support: ^5.7\n\n## Get started\n\n* [Instalação](#Instalação)\n* [Configurando o SDK](#)\n* [Brincando com coleções e métodos mágicos](#)\n* [Recuperando Departamentos](#)\n* [Recuperar PacotesDados](#)\n* [Confirmando consumo de dados](#)\n\n\n### Instalação\n\nUsando composer execute o comando para instalar o pacote:\n\n`composer require prhost/mitryusweb-sdk`\n\n### Configurando o SDK\n\nVeja o exemplo abaixo para configurar principalmente a chave de integração:\n\n```php\nuse Mitryusweb\\Api\\Mitryusweb;\n\nMitryusweb::$token = 'chave de integracao';\n\n//Opcional, setar uma outra URL que não seja a atual da documentação\nMitryusweb::$uri = 'url.ws.mitryusweb';\n```\n\noutro exemplo:\n\n```php\nuse Mitryusweb\\Api\\Mitryusweb;\nMitryusweb::init('chave integracao', 'url api (opcional)');\n```\n\n### Brincando com coleções e métodos mágicos\n\n#### Coleções\nQuando uma consulta é esperado o retorno de varios registros, ele sempre vai retornar uma model que contém uma coleção extendida da biblioteca [Collection do laravel](https://laravel.com/docs/5.7/collections).\nA coleção também tras em cada item de sua coleção uma model do tipo item com os dados daquele registro.\n\nExemplos de uso da coleção:\n\n```php\n$pacoteEndpoint = new \\Mitryusweb\\Endpoints\\PacoteDados();\n$pacoteDados = $pacoteEndpoint-\u003eget();\n\n//Exemplo acessando uma coleção de dados\n$departamentos = $pacoteDados-\u003egetDepartamentos();\n\n//Por departamentos também se uma lista de dados, se torna uma model do tipo coleção.\nforeach ($departamentos as $departamento) {\n    $departamento-\u003egetCodDepartamento();\n}\n```\n\n#### Métodos mágicos\nCom alguns métodos mágicos que contem nas models de retorno, é possível acessar os dados chamando chamando métodos do tipo `$pacoteDados-\u003egetDepartamentos()` que retornará apenas os departamentos daquele pacote.\n\nOutra forma também é através dos atributos, por exemplo, `$pacoteDados-\u003eDepartamentos` ou `$pacoteDados-\u003ecodigo_confirmacao`. Confira a lista de atributos chamando `$pacoteDados-\u003egetAttributeMap()` \n\nAlguns outros exemplos com método mágico e coleções:\n\n### Recuperando Departamentos\n\nPara recuperar os departamentos, use o EndPoint `Departamentos`:\n\n```php\n$departamentosEndpoint = new \\Mitryusweb\\Endpoints\\Departamentos();\n\n//Retorna uma model de coleção baseada na instancia da biblioteca Collection do laravel\n$departamentos = $departamentosEndpoint-\u003eget();\n```\n\n### Recuperar PacoteDados\n\nPara recuperar todos os dados em um unico pacote, use o EndPoint `PacoteDados`:\n\n```php\n$pacoteEndpoint = new \\Mitryusweb\\Endpoints\\PacoteDados();\n\n//Retorna uma model do tipo PacoteDados contendo varias coleções de cada dado.\n$pacoteDados = $pacoteEndpoint-\u003eget();\n\n//Você também pode auto confirmar a recuperação do pacote passando true no paramentro do get():\n$pacoteDados = $pacoteEndpoint-\u003eget(true);\n\n```\n\n### Confirnamdo consumo de dados\n\nPara confirmar que recebeu os dados corretamente usando o codigo_confirmacao use o exemplo abaixo:\n\n```php\n$pacoteEndPoint = new \\Mitryusweb\\Endpoints\\PacoteDados();\n\n$codigo_confirmacao = 123;\n$pacoteEndPoint-\u003econfimar($codigo_confirmacao);\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprhost%2Fmitryusweb-sdk-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprhost%2Fmitryusweb-sdk-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprhost%2Fmitryusweb-sdk-php/lists"}