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

[API][Docs] Authorization docs #11184

Merged
merged 1 commit into from
Mar 6, 2020
Merged
Show file tree
Hide file tree
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
44 changes: 44 additions & 0 deletions src/Sylius/Bundle/ApiBundle/docs/authorization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Sylius API - Authorization

As introduced in [this PR](https://github.com/Sylius/Sylius/pull/11174), you need to authorize with JWT token to be able
to use new Sylius API.

1. Generate SSH keys for JWT

```bash
openssl genpkey -out config/jwt/private.pem -aes256 -algorithm rsa -pkeyopt rsa_keygen_bits:4096
openssl pkey -in config/jwt/private.pem -out config/jwt/public.pem -pubout
```

> Paths for the keys are configured in `.env` files

2. Request for JWT token by the authentication request

```bash
curl -X POST http://127.0.0.1:8000/new-api/authentication-token -H "Content-Type: application/json" -H "Accept: application/json" -d '{"email": "api@example.com", "password": "sylius-api"}'
```

> Email "api@example.com" and password "sylius-api" are default credentials for API administrator provided in the default
[fixtures suite](https://github.com/Sylius/Sylius/blob/0e4ed2e34e7f255aacef02a43cc2e7bf006d03fd/src/Sylius/Bundle/CoreBundle/Resources/config/app/fixtures/shop_configuration.yaml#L158)

In the response you will get a token that need to be passed in each request header.

```json
{"token": "VERY_SECURE_TOKEN"}
```

3. If you're using Api Platform Swagger docs (available on `/new-api/docs/` URL), you can set the authentication token
for each request.

i. Go the the Swagger docs page. Notice the **Authorize** button and unlocked padlock near the available URLs:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
i. Go the the Swagger docs page. Notice the **Authorize** button and unlocked padlock near the available URLs:
i. Go to the Swagger docs page. Notice the **Authorize** button and unlocked padlock near the available URLs:


![not-authorized](https://raw.githubusercontent.com/Zales0123/Sylius/api-authorization-docs/src/Sylius/Bundle/ApiBundle/docs/images/api-platform-not-authorized.png)

ii. Click the **Authorize** button and put the authentication token (remember about the `Bearer` prefix):

![not-authorized](https://raw.githubusercontent.com/Zales0123/Sylius/api-authorization-docs/src/Sylius/Bundle/ApiBundle/docs/images/api-platform-authorization.png)

iii. After clicking **Authorize**, you should see locked padlock near URLs and the proper header should be added to
each API call

![not-authorized](https://raw.githubusercontent.com/Zales0123/Sylius/api-authorization-docs/src/Sylius/Bundle/ApiBundle/docs/images/api-platform-authorized.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.