Coordination with API prototyping partners - Githubissues

cds-snc / platform-forms-client

NextJS application that serves the public-facing website for Forms

https://forms-staging.cdssandbox.xyz/

MIT License

34 stars 13 forks source link

Coordination with API prototyping partners #3889

Open srtalbot opened 3 months ago

srtalbot commented 3 months ago

Approach with partners:

1. Information gathering mode - light touch with devs. Gather information about systems.

[x] Conduct survey to identify potential prototyping partners and high-level requirements
[x] Select 3-5 partners
[x] Establish contact with all partners and identify terms of prototyping.
[x] Identify an approach to roll out API functionality incrementally.

2. Prototyping mode - Work with them to integrate and test.

[x] Implement an authentication flow
[ ] Implement rate limiting
[x] Implement the API server (basic functionality)
[ ] Test initial integrations with partners and get feedback
[ ] Identify additional steps required to get the data into a target system that partners will need to develop (e.g., a plugin for MS Sharepoint or PowerBI).

3. Implement a form - Work with the team to launch a form that uses the data retrieval API

[ ] Organize a ½ a day hackaton to try and get a form live and collecting data with each team
[ ] Identify a way to share how partners were able to integrate with a variety of systems
[ ] Get a live form with each prototyping partner
[ ] Start to test self-service patterns

4. Implement a PBMM form - work with a team to launch a form that uses the data retrieval API for a PBMM form.

[ ] Complete requirements for PBMM
[ ] Work with partners to publish and get the data for 5 PBMM forms to test self-service approach