feat: add interactive API tutorial for new developers - #326
Open
elijah4196 wants to merge 1 commit into
Open
Conversation
|
@elijah4196 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add Interactive API Tutorial for New Developers
Summary
Adds a step-by-step Postman collection that walks new developers through the complete ProxyPay developer flow in under 30 minutes: register → KYC → deposit → withdraw.
What's included
New files in
postman/developer_tutorial.postman_collection.jsondeveloper_tutorial.postman_environment.jsonTutorial structure
Step 1 — Register & Authenticate (~5 min)
1.1Login with phone number → JWT token auto-saved to environment1.2Verify token is valid1.3Get current user profile →userId+stellarAddressauto-savedStep 2 — KYC Verification (~8 min)
2.1Create KYC applicant →applicantIdauto-saved2.2Upload identity document (base64)2.3Start verification workflow →workflowRunIdauto-saved2.4Poll KYC status untilbasiclevel confirmedStep 3 — Deposit (~5 min)
3.1Deposit 500 XAF via MTN mobile money →transactionIdauto-saved3.2Poll transaction status untilcompletedStep 4 — Withdraw (~5 min)
4.1Withdraw 200 XAF to mobile money →withdrawTransactionIdauto-saved4.2Confirm withdrawal completedBonus — Transaction History
How the tutorial meets acceptance criteria
{{variables}}populated by the previous step's Tests script — zero manual copy-pasting requireddescriptionfield explaining what it does, why, and what to expect; inline comments in request bodies explain each fieldTesting
npm run devdeveloper_tutorial.postman_collection.jsoninto Postmandeveloper_tutorial.postman_environment.jsonand select it as the active environmentcloses #272