The state of public APIs| Submit an API

|API RANK| by Escape.tech

Benchmark and ranking of 5138+ public APIs by Escape.tech

Back to the list Request ranking update

Health Repository Provider Specifications for HIU (ranked 4137 of 5138)

https://escape-data-and-specs.s3.fr-par.scw.cloud/specs/Health_Repository_Provider_Specifications_for_HIU_ba7d602f_f435_454d_bec4_7ea55874e982_yaml.yaml

GENERAL INFORMATION

The following are the specifications for the APIs to be implemented at the Health Repository end if an entity is only serving the role of a HIU. The specs are essentially duplicates from the Gateway and Bridge, but put together so as to make it clear to HIUs which set of APIs they should implement to participate in the network.

  1. The APIs are organized by the flows - identification, consent flow, data flow and monitoring. They represent the APIs that are expected to be available at the HIU end by the Gateway.
  2. For majority of the APIs, if Gateway has initiated a call, there are corresponding callback APIs on the Gateway. e.g for /consents/hiu/notify API on HIU end, its expected that a corresponding callback API /consents/hiu/on-notify on Gateway is called. Such APIs are organized under the Gateway label.
  3. Gateway relevant APIs for HIUs are grouped under Gateway label. These include the APIs that HIPs are required to call on the Gateway.

...

Contact

SECURITY 4/5

The security score of an API is computed as the number of OWASP top 10 vulnerabilities detected in the API.

  • OWASP issues detected: API7:2023

PERFORMANCE 1/5

The performance score is derived from the median response time of the API, sometimes referred as p50. The median is the value separating the higher half from the lower half of a data sample, here the response times of the API.

  • The median response time of the API is 886 ms .

Get p50 under 220 ms to get a 4/5 score.

RELIABILITY 5/5

The reliability score is derived from the number of inconsistent server responses, either server errors or non-conforming return values.

  • Self compliance: response objects matched the declared response types.
  • Server errors: the server did not return any 5xx error.

DESIGN 2/5

The design score reflects the quality of the specification file (usually named openapi.json or swagger.json). Having a high-quality specification file (with up-to-date types and examples) help developers understand the API and tools produce relevant documentation.

  • Respects OpenAPI 3.0.0 schema specification.
  • Contains comments and summaries.
  • Contains examples.
  • Does not contain duplicated objects.

Popularity 0/5

The popularity score is computed from the number of references to the API found on the internet. Have your API used by many developers to get a higher score!

Last scanned: 5/4/2023