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.

Sign up for GitHub

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

Rename 3rd party dev - > App developers #1252

Merged
merged 2 commits into from
Nov 26, 2024
Merged

Rename 3rd party dev - > App developers #1252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29921d3
Rename 3rd party developer to app developers
melroy89 Nov 26, 2024
fa46f68
Improve top level readme
melroy89 Nov 26, 2024
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
14 changes: 9 additions & 5 deletions docs/04-3rd_party_developer/README.md → docs/04-app_developers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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]
Expand Down
8 changes: 4 additions & 4 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading