|API RANK| by Escape.tech
Benchmark and ranking of 5138+ public APIs by Escape.tech
SoberSky API Endpoints and Callbacks (ranked 1968 of 5138)
https://escape-data-and-specs.s3.fr-par.scw.cloud/specs/O_h_X5DMx_DtQaCuEUv2x_sobersky_api_endpoints_and_callbacks_json.jsonGENERAL INFORMATION
This document outlines the endpoints and callbacks necessary to integrate
with the SoberSky system.
Authentication
Each SoberSky API HTTP request must be authenticated using Digest Authentication.
In Digest Authentication, each request requires a Username, Api Key, and Auth Key to be sent with each request to verify the request is indeed originating from the authorized API User.
A Auth key is derived from an MD5 hash of several request parameters and is added to the header. Below is an example of posting a client:
POST http://api.soberlink.net/companies/123456/clients HTTP/1.1
Content-Type: application/json
Accept: text/json
Authorization: SOBERLINK 123456:JpxQsY1rUGcLfEOmYvhlbA==
X-Soberlink-Date: 18 AUG 2011 17:03:33 GMT
Host: api.soberlink.net
Content-Length: 436
Expect: 100-continue
Proxy-Connection: Keep-Alive
The Auth Key is composed of the following variables as defined below:
| NAME | DESCRIPTION |
|---|
...
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 5/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 40.2 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 1/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 2.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!