Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Hike Sales API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Finpaas.com%2Finpaas" | shStep 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Finpaas.com%2Finpaas" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
What an agent can do with Hike Sales API.
Log new leads and opportunities in Hike Sales and update them by id as they move through the sales process
Find customer accounts by name with param.title or by Brazilian tax number with param.cpfcnpj
Register new accounts and contacts and keep their records up to date with PUT by id
List sales tasks filtered by param.title, param.description, or param.duedate, and create new ones
GET STARTED
Read a user's pending follow-ups filtered by status such as duetoday or latedue and by workflow type
Patterns agents use Hike Sales API for, with concrete tasks.
★ Sales follow-up assistant through Jentic
An AI agent connected through Jentic starts the day by reading a salesperson's pending items in Hike Sales, filtered to status duetoday or latedue, and turns them into a short call list. It then opens the related opportunity or account by id to add context. The Basic credentials stay in your own Jentic One instance, not in the agent's context.
Call GET /api/bpm-exec-issuedata/v1/pending-issues/data.json with status 'latedue', assigned_user 'Y', order 'ASC', limit 20, and page 1, then list each overdue item
Lead capture from inbound forms
When a prospect fills in a form on your site, create the lead in Hike Sales so it lands in the sales team's queue without retyping. Later, update the same lead by id as it is qualified, and open an opportunity when it is ready to quote.
Call POST /leads with the lead's name, company, and email from the form, then confirm the new lead appears in GET /leads
Account lookup by CPF or CNPJ
Brazilian sales teams identify customers by tax number. The account finder accepts param.cpfcnpj, so an agent can check whether a company already exists before creating a duplicate, and fall back to param.title to search by name.
Call GET /api/data-sources/e/HSFA_CONTA/finders/759826dc-3306-4177-ab86-27819c599f2b/results with param.cpfcnpj '12345678000190' and limit 5, and report whether a matching account exists
21 endpoints — the hike sales api reads and writes the sales records of hike sales, a crm built on the inpaas platform: leads, opportunities, accounts, contacts, and tasks.
METHOD
PATH
DESCRIPTION
/oportunidades
List opportunities
/oportunidades
Create an opportunity
/oportunidades/{id}
Update an opportunity
/leads
Create a lead
/contas/{id}
Get an account by id
/contatos
Create a contact
/api/bpm-exec-issuedata/v1/pending-issues/data.json
Get the user's pending items
/oportunidades
List opportunities
/oportunidades
Create an opportunity
/oportunidades/{id}
Update an opportunity
/leads
Create a lead
/contas/{id}
Get an account by id
/contatos
Create a contact
/api/bpm-exec-issuedata/v1/pending-issues/data.json
Get the user's pending items
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Hike Sales by hand means sending HTTP Basic credentials, passing the user and pass query parameters to the pending items operation, and working with long finder paths for accounts and tasks. Through Jentic you install once, import Hike Sales from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
Hike Sales puts the record id in the URL path for leads, opportunities, accounts, contacts, and tasks (/oportunidades/{id}), so a rule can pin your agent to one record and the operations you pick. You choose the operations it may call, so writes like creating or updating opportunities are not included unless you add them.
Credential isolation
Your Hike Sales credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create a sales lead' or 'find an account by CNPJ', and Jentic returns the matching Hike Sales operation with its input schema so the agent calls the right endpoint without reading the Portuguese reference docs.
Alternatives and complements available in the Jentic catalogue.
Specific to using Hike Sales API through Jentic.
Is there a Hike Sales MCP server?
You don't need an MCP server to give your agent Hike Sales. Jentic connects it directly from the API Directory: import it, store your credentials once, and your agent calls it. The agent finds the lead, opportunity, or task operation it needs on demand, so its context stays free of unused tool definitions.
Can I limit what my agent is allowed to do with the Hike Sales API?
Yes. For a reporting agent, write a rule that allows only GET /oportunidades, GET /oportunidades/{id}, and GET /leads. The agent can read the pipeline but cannot create or change records, and every call it makes is logged. Because the record id is in the URL path, you can also pin a rule to a single opportunity such as /oportunidades/482.
What authentication does the Hike Sales API use?
Per its OpenAPI spec, the Hike Sales API uses HTTP Basic authentication on every operation. The pending items operation also requires the user's login and password as the user and pass query parameters. Through Jentic, these credentials are stored encrypted by your own Jentic One instance and injected when each call runs.
Which server does the Hike Sales spec point to?
The spec's only server is https://hike-sales-dev.inpaas.com, which by its name is a development host. Confirm the correct host for your Hike Sales environment with your provider before pointing an agent at production data.
What are the rate limits for the Hike Sales API?
The OpenAPI spec does not specify rate limits; check https://inpaas.com or your Hike Sales administrator for current limits.
How do I find overdue follow-ups with the Hike Sales API through Jentic?
Install Jentic One with `curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh`, import Hike Sales from the API Directory, and store your credentials. Your agent searches for 'list overdue sales follow-ups', gets the pending items operation with its input schema, and calls it with status latedue plus the required order, limit, assigned_user, and page values. To run it on your own infrastructure, install Jentic One from its GitHub repo.
Know of an official OpenAPI document? Contribute it →
For Agents
List, create, fetch, and update Hike Sales leads, opportunities, accounts, contacts, and tasks, and read a user's pending follow-ups by due status.
Use for: Find the Hike Sales account for CNPJ 12.345.678/0001-90, I need to log a new lead from an inbound form, List all open opportunities in Hike Sales, Update the opportunity with id 482
Not supported: Does not handle invoicing, payments, email sending, or deleting records. Use for reading and updating Hike Sales leads, opportunities, accounts, contacts, and tasks only.
The Hike Sales API reads and writes the sales records of Hike Sales, a CRM built on the InPaaS platform: leads, opportunities, accounts, contacts, and tasks. Each record type can be listed, created, fetched by id, and updated, and the account and task finders accept filters such as param.title, param.cpfcnpj for a Brazilian CPF or CNPJ tax number, and param.duedate. A separate operation returns the signed-in user's pending items, filterable by status (due today, pending, or overdue) and by workflow type. The spec's documentation is written in Portuguese.
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
Base layer of spec validity and structural soundness.
Aggregated quality score from linter diagnostics, weighted by severity.
Percentage of `$ref` references that resolve successfully.
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
Structural correctness score based on schema issues using logarithmic dampening.
Clarity, completeness, and ingestion readiness for developers and tooling.
How richly the API is illustrated with examples.
Percentage of examples that conform to their schemas.
Percentage of operations with complete response definitions (success, client error, server error).
Health of API ingestion, bundling, and resolution within Jentic pipelines.
Semantic breadth, depth, and agent comprehension for AI systems.
Coverage of descriptions across API elements.
Coverage of RFC 9457 Problem Details for error responses.
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
Coverage of summaries across operations/tags/info.
Functional utility, complexity comfort, and AI orchestration readiness.
Agent comfort level based on API operational and structural complexity.
Trust, risk posture, and security compliance.
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
Findability, semantic richness, and reasoning readiness.
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>