OpenAPI Specification for the Fatture in Cloud API.
If you looked at our repo files you almost surely noticed that we have two API specifications:
The openapi.yaml file is the file we use to generate our SDKs, it contains only the necessary information to generate a fully working SDK; to keep the files as simple as possible we split the specification in multiple YAML files, you can find them in the "/models" folder of this repo.
The openapi-enriched.yaml file is the file we use for our API reference documentation, it contains all the info contained in the previous file plus some additional properties, to provide to the user all the details needed for the correct usage of our methods: it includes the required parameters, default values and other useful info. In this case the specification is flattened: it contains all the models that in the previous file were stored separatedly.
To help you interact with our APIs we decided to create a set of dedicated SDKs (Software Developer Kits) in a certain number of programming languages, that can be useful to speed up the integration process. These SDKs provide updated models and methods to contact our APIs with minimal configuration, making it possible to start interacting with Fatture in Cloud within minutes: in most cases, you just need to retrieve the Access Token and you're ready to go!
Here you can find the list of the currently supported SDKs:
| Language | Package |
|---|---|
| C# |  |
| Go |  |
| Java |  |
| JavaScript |  |
| PHP |  |
| Python |  |
| Ruby |  |
| TypeScript |  |
Our SDKs are generated from the OpenAPI specification using the OpenAPI Generator; if we don't support your favorite language yet you can try to generate an SDK on your own! 😃
If you need an SDK for a language we are not supporting right now you can just generate it using the OpenAPI Generator or another tool of your choice.
These are the required steps:
- Install the generator using your preferred method as explained here;
- Generate the SDK you want following these instructions using our openapi.yaml file.
You can find a list of all the languages and additional options supported by the generator here.
It is really easy to test our APIs using our Postman collection:
- Download the postman/fic-api.json file from our repo;
- Import it following this procedure.
You can also directly import our OpenAPI YAML file if you prefer.
The Fatture in Cloud Developers Hub, contains a lot of useful guides and info that can help you with the most common issues that could arise while integrating our APIs and SDKs. Be sure to check it out!