From 29921d3cfba5e33b937add649b03232cf804ef3f Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Tue, 26 Nov 2024 13:54:00 +0100 Subject: [PATCH 1/2] Rename 3rd party developer to app developers --- .../README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) rename docs/{04-3rd_party_developer => 04-app_developers}/README.md (97%) diff --git a/docs/04-3rd_party_developer/README.md b/docs/04-app_developers/README.md similarity index 97% rename from docs/04-3rd_party_developer/README.md rename to docs/04-app_developers/README.md index b9182006e..3767cc576 100644 --- a/docs/04-3rd_party_developer/README.md +++ b/docs/04-app_developers/README.md @@ -1,4 +1,12 @@ -# 3rd Party Developer +# App Developers + +If you wish to develop an app that uses the Mbin API end-points, that is possible by using the OAuth2. + +## API Endpoints + +For all the API endpoints go to the [API documentation page](https://docs.joinmbin.org/api/). + +Or use the Swagger documentation on an existing Mbin instance: `https://mbin_site.com/api/docs`. Assuming you setup the server and the API correctly. ## OAuth2 Guide @@ -19,10 +27,6 @@ - [documentation here](https://www.oauth.com/oauth2-servers/making-authenticated-requests/refreshing-an-access-token/) - Refresh tokens are used with the `authorization_code` grant type to reduce the number of times the user must log in. -### Endpoints - -For all the API endpoints go to the swagger documentation page, which is: `https://your_domain.com/api/docs`. Assuming you setup the server and the API correctly. - ### Obtaining OAuth2 credentials from a new server > [!NOTE] From fa46f6800f2e5d5845d079effbbacf42e43f05f3 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Tue, 26 Nov 2024 13:55:47 +0100 Subject: [PATCH 2/2] Improve top level readme --- docs/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index 16cac3b6d..121a100ba 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ We split up the documentation for: -- [Users](01-user/README.md) -- [Admins](02-admin/README.md) -- [Contributing](03-contributing/README.md) -- and [3rd party developers](04-3rd_party_developer/README.md), meaning API documentation. +- [Users](01-user/README.md) - User guide +- [Admins](02-admin/README.md) - How-to guides for admins +- [Contributing](03-contributing/README.md) - How to contribute to the project +- [App developers](04-app_developers/README.md) - How to use Mbin API