API
An API is an agreed interface that software uses to exchange data or ask other software to perform an action. API stands for Application Programming Interface. It describes what a system offers and how another system can use it.
Prepared with AIContent updated
A request has an address and a purpose
With an HTTP API, your code sends a request to a particular address, called an endpoint. The method indicates the type of action. GET retrieves information. POST often creates something or starts an operation. The documentation for each endpoint determines its precise behaviour.
The response includes a status code and may contain structured data, such as JSON. Your code uses that response to keep working. A good integration also has a plan when a request needs another attempt or a little attention.
Requesting customers from Alunta
A documented read request, shown for explanation without an access token.
GET https://app.alunta.com/api/v1/customers
- Method
GET, retrieve information
- Resource
/customers, customers
- Authentication
Bearer token
This request does not change data. Read the reference for response structure, pagination and access requirements before building on it.
Documentation and access belong together
Alunta’s API reference covers resources including customers, subscriptions and invoices. Its OpenAPI file describes the interface in a format developer tools can also read: addresses, fields, responses and authentication requirements.
The example requires a valid bearer token with the necessary access to your Alunta account. Keep that token securely on your server, away from publicly accessible browser code. The documentation and the token’s permissions determine which information and actions an integration can access. Begin with a request that reads data so you can understand the response before adding changes to your workflow.
APIs, webhooks and MCP do different jobs
With an API, your code initiates a request: “Fetch my customers”. With a webhook, the system sends your integration a message when a particular event happens, such as a payment. Webhooks can therefore avoid repeated requests just to check for changes.
MCP is a standard for connecting AI applications with external data and tools. It provides a different way to offer selected capabilities to an AI assistant. It does not automatically expose every function of an API. Check Alunta’s API and AI access pages for the available options, and choose a connection based on the task your workflow needs to complete.
Questions and answers
Is an API the same as a ready-made integration?
No. An API is an interface you can build with. A ready-made integration connects systems and has already made choices about data, synchronisation and error handling.
Do I need to be a developer to use Alunta?
No. You can use Alunta’s interface and relevant ready-made integrations. The API serves workflows where your own code needs to connect Alunta with another product or a particular process.
