|API RANK| by Escape.tech
Benchmark and ranking of 5138+ public APIs by Escape.tech
Pitcrew API Documentation. (ranked 3437 of 5138)
https://escape-data-and-specs.s3.fr-par.scw.cloud/specs/jIjOUy7NYTvNt8L8Ns1hW_pitcrew_api_documentation__json.jsonGENERAL INFORMATION
Documentation for the Pitcrew API endpoints.
Authentication
Pitcrew API uses a JWT Bearer token authentication method. The token must be supplied in the Authorization
header prefixed with the keyword Bearer
(and a space).
For example, a request to the /installations
endpoint might look like this:
GET /api/v1/installations HTTP/1.1
Host: https://dev.dashboard.pitcrew.ai
Authorization: Bearer eyJhbGc.....
Connection: keep-alive
Content-Type: application/json
To obtain an access token, the user must log in with the provided details as seen in the /login
endpoint documentation.
Additionally, the server will cache all user authorisation for up to 10 seconds after a user request. This means if user permissions are changed, it will take a short time before the user can make an authorised request. To override this behaviour, you may provide the ignore-user-cache
header to your request, and a fresh user authorisation will be generated so timing issues may b
...
Contact
- Name: info@imcontrol.com.au
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 1,110 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 3/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!