What Is Agicap's Public API?

The Public API lets you and your integrators or partners develop technical integrations with Agicap. It enables you to automate data exchange across applications, allowing for seamless integration with your existing tools.

Why Use the Public API?

Here are some immediate benefits of using the Public API:

Enhanced security: Our APIs are protected by a client credential flow. Every organization must generate its own credentials from the Agicap app before starting to use the API. It's more secure as each service uses unique credentials.
Increased performance: Our solution can handle up to 4000 requests per second, allowing your integrations to scale without fearing any API outages.
Consistency: We have defined Agicap API guidelines to ensure that all our exposed APIs have standardized implementations.

In the long term, the Public API will enable use cases that weren't possible with our previous Open API:

Comprehensive monitoring: Monitor API consumption by configured clients and their endpoints.
User-impersonation capabilities: Allow API calls as a user within a client credential system, enabling automated tasks like assigning a user to an entity when they're added to your Active Directory.

How to Get Started with the Public API

1. Access the Public API Documentation

The Public API documentation is available at https://api.agicap.com/. Here, you'll find detailed information on how to make API requests.

2. Generate Your API Credentials

Only Organization Admin users can generate API keys from the Advanced Parameters in the Agicap app. Other users can view existing credentials but cannot generate new ones or delete existing ones.

To generate API credentials:

Navigate to Advanced Parameters in your Agicap account.
Select API Settings.
Click on Generate New Credentials.
Note: For security reasons, the client secret will only be shown once upon generation. Make sure to keep it safe.

👍 It's recommended to use a unique set of API keys for each tool, integrator, or partner.

3. Authenticate Your API Requests

Authentication is managed via API keys and requires a temporary access token. You can retrieve this token using the Authentication request and your API keys.

Each request must include this access token.

4. Making API Requests

API requests are organized into domains and products:

API Domains: Refer to the general business context.
API Products: Refer to specific objects or sets of related objects to interact with.

Most requests are made to retrieve data for a given organization or entity.

The organization ID can be retrieved from the API settings page.
The entity ID can be retrieved via the list entities request.

You can:

Retrieve data from Agicap to update your tools.
Push, update, or delete data in Agicap.

5. Explore API Endpoints

Visit https://api.agicap.com/apis to see the available endpoints and actions you can perform via the Public API.

💡 Tips

Keep Your Credentials Safe: Your client secret is only shown once. Store it securely.
Use Unique Credentials: Generate separate API keys for each service or integration for better security.
Check the Documentation: Always refer to https://api.agicap.com/ for the most up-to-date information.

Q&A ❓

What's the Difference Between the Public API and the Open API?

Be careful not to mix Open API and Public API; they're two different things:

Open API: Allows you to create Business and Banking connections (mostly through AFT) and is managed by the Data Integration team. Endpoints start with openapi.agicap.com.
Public API: Allows you to send and retrieve various data from Agicap securely and efficiently. Endpoints start with api.agicap.com.

The Public API offers enhanced security, performance, and new capabilities not available with the Open API.

How Do I Migrate from the Open API to the Public API?

Our goal is to transition all use cases to the Public API. We will contact clients still using the Open API once all use cases are covered on the Public API.

Can I Get Assistance Setting Up the Public API?

Customers are supposed to be autonomous in setting up the Public API by following the instructions on the public site https://api.agicap.com/. If you need further assistance, please let us know.