This documentation will guide you through the LinkApi Code Builder, the best integration tool for developers, giving you the freedom to create integrations any way you want. Here you will get familiar with our documentation, knowing all you can do with our platform. We love feedback and always want to improve, so if you had any problems with this documentation, or if the content helped you, please let us know!
Of all you can do inside the Platform, we can divide it between three steps and this guide will have the same structure.
This glossary will be a quick guide for all your technical terms inside our platform. If you still have any problems, don't hesitate to contact us!
Also known as Command Line Interface, the LinkApi CLI contains commands with basic language and complex actions through your computer terminal. They will help you with actions such as login, creating a project, cloning a project, publishing and so on.
For more information and all the CLI commands, access our CLI content!
LinkApi proudly presents our Software Development Kit, a module created to help with the complex process of creating integrations. Save your time using methods that solve the hardest part of integration building, leaving for you just the easy part.
For more information and all the SDK commands access our SDK content!
Your Catalog will contemplate all the private files in your directory. Applications, Data-transformation - Data-transformation - Data-transformations are responsible for converting a Payload returned from a Resource and make it understandable to another Resource to connect with. , business rules, functions and whatever you like, that must be to be shared with the projects. Each subscriber has their own private Catalog.
The Universal Catalog is the LinkApi stable catalog that has the most requested platforms by the LinkApi integration community. This catalog can be consumed easily through our SDK. You will only need to set the credentials and the params expected by the select application and resource.
We will call a Universal Application every third-company endpoint that is ready to connect with LinkApi. They will hold all the resources to be consumed via coding. For example, if you want to connect with MailChimp and send an email, you can use our already crafted Universal Application connection.
You can also build your own integrations with your own credentials. Hands on the code!
A resource is the encapsulation of an endpoint. Your Resources will contain all code formatting and process to make a successful consume of the desired service. You may use our SDK to save some time on this part.
Example of a Resource inside the Project Explorer.
Functions are a static piece of code that can be reused any number of times in your integrations. They will expect an input and a return output based on the data sent. All functions will be under your personal Catalog.
Example of a Function inside the Catalog Explorer.
Data-transformations are responsible for converting a Payload returned from a Resource and make it understandable to another Resource to connect with.
Example of a coded Data-Transformation inside the Catalog Explorer.
An Automation is a complete integration flow. The automation orchestrates all the resources, functions, data-transformation on your catalog and the SDK to make all the requests and logical rules needed.
A project is where all the Automation needed between Applications stay in. This will be the final package ready for distribution.
The Triggers are responsible to make you Automation run. Just choose an Automation, the payload that will be used, and how often you want it to run.
Using the API Hub you are able to see all the Resources that we have as endpoints. You just need to configure the credentials to make the endpoint available and send the filters or params needed by that Resource.
A transaction is an individual record that says if the data has been integrated successfully or not.
For more information, check our Transaction content!
Trace is a log box that is generated in any part of your automation. You can set when, how and which data will be shown in a trace. Traces are generated inside of a Transaction.
Now that you are familiar with the LinkApi glossary, it's time to take the first steps towards your integration.