Skip to content
This repository has been archived by the owner on Nov 26, 2024. It is now read-only.

Commit

Permalink
Update Readme (#9)
Browse files Browse the repository at this point in the history
* update README

* update version number

Co-authored-by: Maxime Girma <maxime.gàhelloasso.com>
  • Loading branch information
mgi-dev authored May 12, 2022
1 parent 862d1ce commit 3b3eda0
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 48 deletions.
95 changes: 48 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ api = HaApiV5(
| oauth2_token_setter (OPTIONAL) | Vous pouvez utiliser les kwargs oauth2_token_getter et oauth2_token_setter sur le client pour utiliser un stockage personnalisé (partage entre instance / switch de tokens). | function |



## AUTHENTIFICATION


Expand All @@ -39,53 +38,8 @@ L'authentification est gérée par le SDK, Il suffit de fournir client_id et cli
l'instanciation de la classe HaApiV5. Le SDK se charge de gérer les appels pour obtenir des
access et refresh tokens ainsi que les éventuels rafraichissements.


## AUTHORIZATION


Pour obtenir des droits sur des ressources protégées il est nécessaire de passer par la mire d'authorisation.

La methode generate_authorize_request génère l'url permettant de récupérer le consentement utilisateur

```python
from apiv5 import ApiV5

api = ApiV5(
api_base='api.helloasso.com',
client_id=XXXXXX,
client_secret=XXXXXX,
timeout=60
)

request = api.authorization.generate_authorize_request(redirect_url="https://url.de.callback/callback", state="123")
full_url = request["full_url"]
code_verifier = request["code_verifier"]
```

Gardez le code_verifier, il permettra plus tard de finaliser le processus d'autorisation.

Dirigez l'utilisateur vers l'url présente dans full_url, il lui sera demandé de valider l'autorisation.
Un callback sera alors effectué vers la redirect_url renseignée.

Ce callback contient notamment le code nécessaire à la prochaine étape, récupérez ce code et appelez la methode suivante :

```python
response = api.authorization.exchange_authorization_token(authorization_code, "https://url.de.callback/callback", code_verifier)
```

exchange_authorization_token renvoie l'access_token permettant d'accèder aux données de l'association. (Voir méthode)

```python
api.set_access_token(response["access_token"])
response = api.call("/v5/users/me/organizations")
```

Pour plus de détails sur la procédure d'autorisation : https://drive.google.com/file/d/1SmzEDQsiPX6h97otai2L7JmeYvD_F0-r/view


## USAGE EXEMPLE


Une fois authentifié il est possible d'utiliser l'api de facon simple :

```python
Expand Down Expand Up @@ -134,4 +88,51 @@ api.authorization.generate_authorize_request(...)
...

api.organization.get_by_slug("test-asso")
```
```


## AUTHORIZATION

L'authorization est uniquement utilisée par les partenaires de HelloAsso.
Elle permet aux partenaires de récuperer les informations privées d'une association qui lui est lié.
Vous ne pourez pas utiliser cette fonctionnalité si vous n'êtes pas partenaire Helloasso.


Pour obtenir des droits sur des ressources protégées il est nécessaire de passer par la mire d'authorisation.

La methode generate_authorize_request génère l'url permettant de récupérer le consentement utilisateur

```python
from apiv5 import ApiV5

api = ApiV5(
api_base='api.helloasso.com',
client_id=XXXXXX,
client_secret=XXXXXX,
timeout=60
)

request = api.authorization.generate_authorize_request(redirect_url="https://url.de.callback/callback", state="123")
full_url = request["full_url"]
code_verifier = request["code_verifier"]
```

Gardez le code_verifier, il permettra plus tard de finaliser le processus d'autorisation.

Dirigez l'utilisateur vers l'url présente dans full_url, il lui sera demandé de valider l'autorisation.
Un callback sera alors effectué vers la redirect_url renseignée.

Ce callback contient notamment le code nécessaire à la prochaine étape, récupérez ce code et appelez la methode suivante :

```python
response = api.authorization.exchange_authorization_token(authorization_code, "https://url.de.callback/callback", code_verifier)
```

exchange_authorization_token renvoie l'access_token permettant d'accèder aux données de l'association. (Voir méthode)

```python
api.set_access_token(response["access_token"])
response = api.call("/v5/users/me/organizations")
```

Pour plus de détails sur la procédure d'autorisation : https://drive.google.com/file/d/1SmzEDQsiPX6h97otai2L7JmeYvD_F0-r/view
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

setup(
name="helloasso_apiv5",
version="1.0.0",
version="1.0.1",
description="Python wrapper for Helloasso APIV5",
long_description=long_description,
long_description_content_type="text/markdown",
Expand Down

0 comments on commit 3b3eda0

Please sign in to comment.