Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(sdk/php): add error handling docs #550

Merged
merged 1 commit into from
Jul 24, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/sdk/php/error-handling.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
id: sdk-php-error-handling
title: Manipulação de erros
tags:
- php
- api
- sdk
---

Ao utilizar o SDK de PHP, espera-se que a integração seja robusta; sendo assim, é fundamental lidar com possíveis imprevistos da API ou do transporte de dados na forma de [_exceptions_](https://www.php.net/manual/en/language.exceptions.php).

Quando a API retorna um erro, uma exception do tipo `\OpenPix\PhpSdk\ApiErrorException` é lançada.

Caso ocorra algum erro no transporte dos dados, o cliente HTTP utilizado irá lançar uma exceção que _estende_ `\Psr\Http\Client\ClientExceptionInterface` de acordo com a [PSR-18](https://www.php-fig.org/psr/psr-18/#clientexceptioninterface).

A mensagem de erro de uma possível exceção pode ser obtida pelo método [`getMessage`](https://www.php.net/manual/pt_BR/exception.getmessage.php).

Veja como você pode capturar todos os possíveis erros do SDK:

```php
use OpenPix\PhpSdk\ApiErrorException;
use Psr\Http\Client\ClientExceptionInterface;

try {
$charge = [
"value" => 100, // R$ 100,00
"correlationID" => "anothercorrelationid-" . strval(time()),
];

/** @var \OpenPix\PhpSdk\Client $client */
$result = $client->charges()->create($charge);
} catch (ApiErrorException|ClientExceptionInterface $e) {
// Lida com os erros relacionados ao SDK.
echo "Ocorreu um erro durante a criação da cobrança: " . $e->getMessage() . "<br>\n";
}
```