Connect your systems through a sequence of Application Programming Interface (API) applications. Fuel Cycle currently has four REST APIs (click this link for programmer information):
Commons API
This API can be called when using FCX or Core APIs. Use the Commons API to request...
- List Groups—This API will provide a list of groups, regardless of their type (static, dynamic, subgroup).
- Check Membership—This API returns members that are in groups based on the group ID.
- Get User Data—The API returns the profile points for the requested user by referencing the user ID passed in the redirect URL.
- Get User Data by External ID—The API returns the profile points for the requested user by referencing the external ID passed in the redirect URL.
- Get Users—This API returns a list of users.
- Erase User—This API erases user data and sets the status of deleted users to DELETED.
Core API
This is the main entry point for interacting with Fuel Cycle’s API. Use this API to:
- Create or update an activity.
- Create, update, or view Delta Testing tickets, comments, and projects.
- Utilize the custom member profiling (P2 engine) data.
- Update multiple members at one time through Batch Update.
- Export data in ZIP file format.
- Add documents and images securely through the Asset Library.
FCX API
Fuel Cycle Exchange marketplace APIs. Use the FCX API to create, update, or view an FCX study.
- Create Study—This API creates a new study and makes it available to attach to community activities.
- Update Study—This API updates the requested study details.
- Get Study—This API returns the information for the requested study.
- Update Study Track—This API updates the requested study track to inform Fuel Cycle. that a participant has completed the study by referencing the study track ID.
Survey API
Use the Survey API to create, update, or view surveys and responses from any service provider.
-
Create Survey—This API creates a new survey and makes it available to attach to community activities. In response, the API sends you the "Created Date" of the survey. The survey also sends “id” in response, the Fuel Cycle survey ID, which you need to store. The system generates survey reference IDs upon successful transmission. Sending duplicate survey reference IDs will generate an error message through the Create Survey API. If you wish to reimport a survey, use the Update Survey API call.
- Update Survey—This API updates the requested survey details, such as text changes, new questions, or answer options.
- Get Survey by ID—This API returns information on the requested survey. For example, you call the API to make sure the Fuel Cycle platform matches what you have in your system and the surveys are the same.
- Get List of Surveys—This API enables you to view if the survey exists in Fuel Cycle or not. For example, you can make a call to see if you need to create a survey (survey reference ID doesn’t exist yet) or update the survey (survey reference already exists).
- Create Response—This API creates a new response and connects it to a specific survey.
- Update Response—This API updates the requested survey response details, for example, if you have a blank response for a user.
- Get Response by ID—This API returns the information for the requested study, to check to see if you have any responses missing, for example.
- Get List of Responses—This API enables you to view if the survey response exists in Fuel Cycle or not. For example, you can make a call to see if you need to create a response (response reference ID doesn’t exist yet) or update the response (response reference ID already exists).
NOTE: there is no import validation. The API adds all surveys posted using the Create Survey API, regardless of content.