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

TrustFile Connector Management API (ranked 1740 of 5138)

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

GENERAL INFORMATION

All custom integration / ETL ought to behave/operate in the exact same way. Adhering to this documentation will allow this

Tokens:

  • connectorToTFToken: identifies the connector and restricts access to environments / version of TF API the connector is certified for (see below for token usage in header)
  • TFToConnectorToken: authorizes Trustfile to access operate the connector micro-service API
  • connectionId: identifies and authorizes access to the TF company to push data into. Mapped to a UUID Company Token in database

Connector Management API responsibility

  • Integrating with TF Items API
  • Integrating with host system API, including authorization (typically something like oAuth)
  • ETL of sales/refunds/tax/shipping data into TrustFile data model
  • Basic management of user data sources: CRUD, enable/disable/status
  • Scheduling and load balancing of users data synchronization
  • Data integrity. It is the responsibility of the connector micro-service to know what data

...

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 4/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 170 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 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!

Last scanned: 5/4/2023