[UXPROD-994] Edge API Core (Common Infrastructure) Created: 09/Jul/18  Updated: 12/Mar/21  Resolved: 04/Jun/19

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: Q4 2018

Type: Epic Priority: P3
Reporter: VBar Assignee: VBar
Resolution: Done Votes: 0
Labels: edgeapi, external_sys_int
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Cloners
clones UXPROD-347 Edge API Core (Common Infrastructure) Open
Epic Name: Edge API Core (Common Infrastructure)
Front End Estimate: Small < 3 days
Front End Estimator: VBar
Back End Estimate: XXL < 30 days
Back End Estimator: VBar
Rank: Chalmers (Impl Aut 2019): R1
Rank: Chicago (MVP Sum 2020): R1
Rank: Cornell (Full Sum 2021): R1
Rank: 5Colleges (Full Jul 2021): R1
Rank: Lehigh (MVP Summer 2020): R1
Rank: TAMU (MVP Jan 2021): R1
Rank: U of AL (MVP Oct 2020): R1
Start date (migrated):
End date:

 Description   

Edge APIs:

Edge APIs for Folio are designed to allow external systems to integrate with Folio. These are distinct from the internal APIs used by Folio and implemented though Okapi. It is not recommended that external systems integrate directly with Folio/Okapi APIs.

Edge APIs....

  • do not require external systems to integrate to any of the highly specific and homegrown conventions established and required by Okapi
  • can be created which present a familiar interface to external systems which have already created integration to other ILSes for similar purposes (e.g. RTAC)
  • allow the use of standard API authentication techniques such as APIKeys, OAuth, etc..
  • can provide plans and management features such as: data caps; bandwidth restrictions; etc...
  • are versioned independently of the versioning of internal Folio API modules, allowing greater stability for external integrations.
  • can be a conversion layer to allow support for data formats not natively supported by Folio: (e.g. XML)
  • can implement non-HTTP protocols as needed
  • can provide coarse-grain APIs that aggregate multiple calls to internal Folio (fine-gran) APIs.
  • are compatible with future trends in device integration (e.g. checkout machines) where these are IoT devices

The scope of this feature is the implementation of common infrastructure to all Edge APIs

Estimates from stories:

  • UXPROD-354 Open Authorization support for Edge APIs FE: None BE: Large < 10 days
  • UXPROD-353 Open Configuration support for Edge APIs FE: Small < 3 days BE: Medium < 5 days
  • UXPROD-352 Open Edge API Common Infrastructure (APIKey management, policies) FE: None BE: Large < 10 days

Not included in roll-up:

  • UXPROD-322 Open Edge API (Patron Portal) for Right to Erasure FE: None BE: Medium < 5 days CB: Not counting this one, as it's already counted in UXPROD-291 Open
  • UXPROD-320 Open Edge API (Patron Portal) for Right to Rectification FE: None BE: Medium < 5 days CB: already included in * UXPROD-290 Open
  • UXPROD-319 Open Edge API (Patron Portal) to deliver user report FE: None BE: Medium < 5 days CB: already included in * UXPROD-289 Open

Generated at Fri Feb 09 00:12:05 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.