From e5be6e3f3022830220eab9af387ef11d11ceeda0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Campitelli?= <1877191+vcampitelli@users.noreply.github.com> Date: Thu, 29 Feb 2024 20:55:56 -0300 Subject: [PATCH] :memo: refs #31 Several changes to the README file --- .github/dependabot.yml | 6 ++ README.md | 142 +++++++++++++++++++++++++++++++---------- 2 files changed, 116 insertions(+), 32 deletions(-) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..30a88e2 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: "docker" + directory: "/.github/fusionauth" + schedule: + interval: "weekly" diff --git a/README.md b/README.md index efb3358..ff1fe70 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ ## Intro + + If you're integrating FusionAuth with a PHP application, this library will speed up your development time. Please also make sure to check our [SDK Usage Suggestions page](https://fusionauth.io/docs/sdks/#usage-suggestions). For additional information and documentation on FusionAuth refer to [https://fusionauth.io](https://fusionauth.io). @@ -20,25 +24,52 @@ Then, include the `composer` autoloader in your PHP files. require __DIR__ . '/vendor/autoload.php'; ``` -## Questions and support +## Examples -If you have a question or support issue regarding this client library, we'd love to hear from you. +### Set Up -If you have a paid plan with support included, please [open a ticket in your account portal](https://account.fusionauth.io/account/support/). Learn more about [paid plan here](https://fusionauth.io/pricing). +First, you have to make sure you have a running FusionAuth instance. If you don't have one already, the easiest way to install FusionAuth is [via Docker](https://fusionauth.io/docs/get-started/download-and-install/docker), but there are [other ways](https://fusionauth.io/docs/get-started/download-and-install). By default, it'll be running on `localhost:9011`. -Otherwise, please [post your question in the community forum](https://fusionauth.io/community/forum/). +Then, you have to [create an API Key](https://fusionauth.io/docs/apis/authentication#managing-api-keys) in the admin UI to allow calling API endpoints. -## Examples +You are now ready to use this library! + +### Error Handling + +After every request is made, you need to check for any errors and handle them. To avoid cluttering things up, we'll omit the error handling in the next examples, but you should do something like the following. + +```php +// $result is the response of one of the endpoint invocations from the examples below + +if (!$result->wasSuccessful()) { + echo "Error!" . PHP_EOL; + echo "Got HTTP {$result->status}" . PHP_EOL; + if (isset($result->errorResponse->fieldErrors)) { + echo "There are some errors with the payload:" . PHP_EOL; + var_dump($result->errorResponse->fieldErrors); + } + if (isset($result->errorResponse->generalErrors)) { + echo "There are some general errors:" . PHP_EOL; + var_dump($result->errorResponse->generalErrors); + } +} +``` ### Create the Client +To make requests to the API, first you need to create a `FusionAuthClient` instance with [the API Key created](https://fusionauth.io/docs/apis/authentication#managing-api-keys) and the server address where FusionAuth is running. + ```php -$apiKey = "5a826da2-1e3a-49df-85ba-cd88575e4e9d"; -$client = new FusionAuth\FusionAuthClient($apiKey, "http://localhost:9011"); +$client = new FusionAuth\FusionAuthClient( + apiKey: "", + baseURL: "http://localhost:9011", // or change this to whatever address FusionAuth is running on +); ``` ### Create an Application +To create an [Application](https://fusionauth.io/docs/get-started/core-concepts/applications), use the `createApplication()` method. + ```php $result = $client->createApplication( applicationId: null, // Leave this empty to automatically generate the UUID @@ -48,17 +79,19 @@ $result = $client->createApplication( ], ], ); -if (!$result->wasSuccessful()) { - // Check HTTP Code at $result->status - // and error message at $result->errorResponse -} -// Hooray! Success +// Handle errors as shown in the beginning of the Examples section + +// Otherwise parse the successful response var_dump($result->successResponse->application); ``` +[Check the API docs for this endpoint](https://fusionauth.io/docs/apis/applications#create-an-application) + ### Adding Roles to an Existing Application +To add [roles to an Application](https://fusionauth.io/docs/get-started/core-concepts/applications#roles), use `createApplicationRole()`. + ```php $result = $client->createApplicationRole( applicationId: 'd564255e-f767-466b-860d-6dcb63afe4cc', // Existing Application Id @@ -72,62 +105,107 @@ $result = $client->createApplicationRole( ], ); -if (!$result->wasSuccessful()) { - // Check HTTP Code at $result->status - // and error message at $result->errorResponse -} +// Handle errors as shown in the beginning of the Examples section -// Hooray! Success +// Otherwise parse the successful response var_dump($result->successResponse->role); ``` +[Check the API docs for this endpoint](https://fusionauth.io/docs/apis/applications#create-an-application-role) + ### Retrieve Application Details +To fetch details about an [Application](https://fusionauth.io/docs/get-started/core-concepts/applications), use `retrieveApplication()`. + ```php $result = $client->retrieveApplication( applicationId: 'd564255e-f767-466b-860d-6dcb63afe4cc', ); -if (!$result->wasSuccessful()) { - // Check HTTP Code at $result->status - // and error message at $result->errorResponse -} +// Handle errors as shown in the beginning of the Examples section -// Hooray! Success +// Otherwise parse the successful response var_dump($result->successResponse->application); ``` +[Check the API docs for this endpoint](https://fusionauth.io/docs/apis/applications#retrieve-an-application) + ### Delete an Application +To delete an [Application](https://fusionauth.io/docs/get-started/core-concepts/applications), use `deleteApplication()`. + ```php $result = $client->deleteApplication( applicationId: 'd564255e-f767-466b-860d-6dcb63afe4cc', ); -if (!$result->wasSuccessful()) { - // Check HTTP Code at $result->status - // and error message at $result->errorResponse -} +// Handle errors as shown in the beginning of the Examples section -// Hooray! Success +// Otherwise parse the successful response // Note that $result->successResponse will be empty ``` +[Check the API docs for this endpoint](https://fusionauth.io/docs/apis/applications#delete-an-application) + ### Lock a User +To [prevent a User from logging in](https://fusionauth.io/docs/get-started/core-concepts/users), use `deactivateUser()`. + ```php $result = $client->deactivateUser( 'fa0bc822-793e-45ee-a7f4-04bfb6a28199', ); -if (!$result->wasSuccessful()) { - // Check HTTP Code at $result->status - // and error message at $result->errorResponse -} +// Handle errors as shown in the beginning of the Examples section -// Hooray! Success +// Otherwise parse the successful response ``` +[Check the API docs for this endpoint](https://fusionauth.io/docs/apis/users#delete-a-user) + +### Registering a User + +To [register a User in an Application](https://fusionauth.io/docs/get-started/core-concepts/users#registrations), use `register()`. + +The code below also adds a `customer` role and a custom `appBackgroundColor` property to the User Registration. + +```php +$result = $client->register( + userId: 'fa0bc822-793e-45ee-a7f4-04bfb6a28199', + request: [ + 'registration' => [ + 'applicationId' => 'd564255e-f767-466b-860d-6dcb63afe4cc', + 'roles' => [ + 'customer', + ], + 'data' => [ + 'appBackgroundColor' => '#096324', + ], + ], + ], +); + +// Handle errors as shown in the beginning of the Examples section + +// Otherwise parse the successful response +``` + +[Check the API docs for this endpoint](https://fusionauth.io/docs/apis/registrations#create-a-user-registration-for-an-existing-user) + + + +## Questions and support + +If you find any bugs in this library, [please open an issue](https://github.com/FusionAuth/fusionauth-php-client/issues). Note that changes to the `FusionAuthClient` class have to be done on the [FusionAuth Client Builder repository](https://github.com/FusionAuth/fusionauth-client-builder/blob/master/src/main/client/php.client.ftl), which is responsible for generating that file. + +But if you have a question or support issue, we'd love to hear from you. + +If you have a paid plan with support included, please [open a ticket in your account portal](https://account.fusionauth.io/account/support/). Learn more about [paid plan here](https://fusionauth.io/pricing). + +Otherwise, please [post your question in the community forum](https://fusionauth.io/community/forum/). + ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/FusionAuth/fusionauth-php-client.