magpi Adaptor developer README.md
N.B.: The Magpi API is under development and this pack may change.
View all the required and optional properties for
state.configuration in the
Fetch data from Magpi
Allows you to fetch data from Magpi and post it elsewhere.
Submit new records
wip: This will allow you to push data to Magpi to create a new record for a form which exists in a user account.
Magpi Outbound API Parameters:
username: The account username.
accesstoken: The accesstoken generated on the site. Each accesstoken is associated with the user who generated.
surveyid: The surveyid is not the survey's name. The surveyid can be obtained from the list of forms generated in 1 above.
startdate: Start date of the data to be returned. Filtering is done based on the DateStamp and is inclusive.(Optional). The date format should be the same one as the one on the data tab/ The date format should be the same one as the one on the data tab
enddate: End date of the data to be returned. Filtering is done based on the DateStamp and is inclusive.(Optional)
Clone the adaptors monorepo. Follow the
Getting Started guide inside to get set up.
Run tests using
pnpm run test or
pnpm run test:watch
Build the project using
To just build the docs run
pnpm build docs