API Conventions
Common rules to use Hive APIs
Environments and version
| Environment | Basic URL |
|---|---|
| Production | https://api.eis.it |
Published application endpoints use prefix /v1. Authentication uses /auth/api-key/login.
Request formats
The format depends on the operation:
application/jsonfor structured body;application/x-www-form-urlencodedfor login and operations indicated in reference;multipart/form-datafor uploading mixed files and modules.
Use exactly names, types and mandatoryities listed in reference. This also applies to parameters path and query and for the legacy fields.
Answers
Response payloads are defined for single operation. Some endpoints return an object, others a list or a bodyless response.The client code must then be based on the endpoint schema and its HTTP status.
Dates and identifications
The date, time and identification format is not uniform among all modules. Do not apply global conversions: check the type and example stated in the specific scheme.
The contract published does not declare a global frequency limit. Do not assume thresholds not present in the reference.