Skip to content

Add OAuth curl examples and improve authentication documentation - #178

Merged
Eric Zwaal (ezw2000) merged 9 commits into
mainfrom
ezw2000-add-oauth-curl-examples
Aug 26, 2026
Merged

Add OAuth curl examples and improve authentication documentation#178
Eric Zwaal (ezw2000) merged 9 commits into
mainfrom
ezw2000-add-oauth-curl-examples

Conversation

@ezw2000

Copy link
Copy Markdown
Collaborator

Summary

Enhance the authentication documentation with practical cURL examples and realistic API response samples for both OAuth flows, making it easier for developers to integrate OAuth authentication.

Changes

  • cURL examples: Added step-by-step cURL examples for Client Credentials flow and Authorization Code flow with PKCE, including token retrieval and API calls
  • Response samples: Added JSON response examples showing actual API response structure with skip, take, and rows fields
  • Realistic endpoints: Updated examples to use the actual API connector path (connectors/Profit_Address) instead of generic placeholder
  • Documentation clarity: Enhanced endpoint sections to clarify that both REST and SOAP APIs use the same OAuth endpoints
  • Formatting fixes: Corrected markdown code fence rendering (backticks were escaped)
  • Parameter descriptions: Preserved helpful descriptions for complex parameters (state, code_challenge, code_challenge_method, code_verifier)

Files Modified

  • markdownpages/profit/nl/authentication.md - Dutch OAuth documentation
  • markdownpages/profit/en/authentication.md - English OAuth documentation

Both versions were updated consistently with matching examples and formatting.

Eric Zwaal (ezw2000) and others added 7 commits August 26, 2026 14:45
- Add curl examples for Client Credentials flow
- Add curl examples for Authorization Code flow with PKCE
- Include JSON response examples for token endpoints and API calls
- Update token_type field values to Bearer instead of placeholder

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
- Restore 'state' description for CSRF protection
- Restore 'code_challenge' and 'code_challenge_method' descriptions
- Restore 'code_verifier' description

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
- Add curl examples for Client Credentials flow
- Add curl examples for Authorization Code flow with PKCE
- Include JSON response examples for token endpoints and API calls
- Update token_type field values to Bearer instead of placeholder
- Restore parameter descriptions (state, code_challenge, code_challenge_method, code_verifier)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
- Change API endpoint from REST/V1/Employees to connectors/Profit_Address
- Update response structure to match actual API format (skip, take, rows)
- Use actual address data from get-connector examples
- Add Accept header to API calls
- Remove 'count' field from response (not in actual API response)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Remove duplicate colon in Accept endpoint line.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
- Update date in Dutch authentication.md
- Update date in English authentication.md

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI lite review requested due to automatic review settings August 26, 2026 13:15
@ezw2000
Eric Zwaal (ezw2000) enabled auto-merge (squash) August 26, 2026 13:16

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Deze PR verbetert de Profit OAuth-authenticatiedocumentatie door praktische (c)URL-voorbeelden en realistischere response-samples toe te voegen, zodat integrators sneller een werkende OAuth-implementatie kunnen opzetten.

review nodig: nee
labels: 📚 leerzaam

Changes:

  • Toegevoegd: stap-voor-stap cURL-voorbeelden voor Client Credentials en Authorization Code + PKCE (token ophalen + API-call).
  • Toegevoegd: voorbeeldresponses met skip, take en rows, en voorbeelden op een realistischer connectorpad (connectors/Profit_Address).
  • Verduidelijkt: OAuth-endpoints gelden voor zowel REST als SOAP + markdown-formatting verbeteringen.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
markdownpages/profit/nl/authentication.md NL-documentatie uitgebreid met cURL-voorbeelden en response-samples; endpoints verduidelijkt.
markdownpages/profit/en/authentication.md EN-documentatie uitgebreid met cURL-voorbeelden en response-samples; endpoints verduidelijkt.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread markdownpages/profit/en/authentication.md Outdated
Comment thread markdownpages/profit/nl/authentication.md Outdated
Eric Zwaal (ezw2000) and others added 2 commits August 26, 2026 15:33
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@ezw2000
Eric Zwaal (ezw2000) merged commit a4ad9dd into main Aug 26, 2026
8 checks passed
@ezw2000
Eric Zwaal (ezw2000) deleted the ezw2000-add-oauth-curl-examples branch August 26, 2026 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants