Fictioneers NPM

Fictioneers API

This is a simple SDK for use when connecting to the Fictioneers API from a browser or server-side application.

To use, you require a Fictioneers API key, a Secret key should only be used by server-side apps and a Visible key can be used by client-side apps, and optionally, a user ID. If you do not provide a user ID, and the API call requires one, the SDK will create one for you, which you can retrieve either from the API response or from the SDK with getUserId().

const fictioneers = new Fictioneers({
    apiKey: "s_xxxxx", // mandatory
    userId: "1234-5678" // optional
})

The methods are asynchronous and (mostly) return a Promise which resolves to JSON. Use like this, for example:

const timelines = await fictioneers.getTimelines()
for (timeline in timelines) {
    ...
}

The following methods are provided in addition to the methods that map to the Fictioneers API:

getUserId()
setUserId()

These methods map to the corresponding methods in the API:

Auth

The method getAccessToken() is used internally by the SDK, so you shouldn't need to use it, but calling it will return the access token used by the SDK to call the API.

The method setAccessToken() will both call getAccessToken() to generate a new access token and reset the access token within the SDK, if the SDK's current access token is either not present or has expired. Again, you shouldn't normally need to use this method.

Users

User from the authentication token.

getUser({includeNarrativeState = false}) => GET /users/me
deleteUser() => DELETE /users/me
createUser({timelineId, disableTimeGuards = false, pauseAtBeats = false}) => POST /users

User timeline progression

Increases the user's current step, making more events available.

progressUserStep({maxSteps = null, pauseAtBeats = true}) => POST /users/me/progress-step

User timeline events

Methods relating to user timeline events.

getUserTimelineEvents() => GET /user-timeline-events
followLinkUserTimelineEvent({timelineEventId, linkId}) => POST /user-timeline-events/follow-link

For further information on these methods and the parameters, please view the documentation

Admin API

Admin service to programmatically manage timelines and timeline users. A Secret API Key is required in the HTTP Authorization header.

getTimelines() => GET /timelines
getTimeline({timelineId}) => GET /timelines/${timelineId}
getTimelineUsers({timelineId}) => GET /timelines/${timelineId}/users
deleteTimelineUsers({timelineId}) => DELETE /timelines/${timelineId}/users
getTimelineUser({timelineId, userId = null}) => GET /timelines/${timelineId}/users/${userId}
deleteTimelineUser({timelineId, userId = null}) => DELETE /timelines/${timelineId}/users/${userId}
getTimelineEventStateChanges({timelineId}) => GET /timelines/${timelineId}/event-state-changes/