canonical: https://jentic.com/apis/swaggerhub.gmf-tech/api-collector

# Gmf Tech api collector

swagger das apis de coletores de editais. The API exposes 9 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically subir editais oriundos dos portais
, detalhes do edital
. Covers 9 operations with oauth2 authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Subir editais oriundos dos portais
- Detalhes do edital
- tras lista de editais simplificada
- status dos editais: scope-> collect:read
- Lista unid. compradoras: scope-> collect:read

## Use cases

### Developer Tools Operations

Use the API collector to perform developer tools operations programmatically. The API provides 9 endpoints covering core functionality including subir editais oriundos dos portais
, detalhes do edital
, tras lista de editais simplificada
.

Example prompt: Call PUT /auction/attachments to subir editais oriundos dos portais

### Automated auctions Management

Automate auctions operations by combining multiple API collector endpoints. Agents can detalhes do edital
 and then tras lista de editais simplificada
 in a single workflow.

Example prompt: Call GET /auction/{auction_id} to detalhes do edital
, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call API collector endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually.

Example prompt: Search Jentic for 'subir editais oriundos dos portais
', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| PUT | /auction/attachments | Subir editais oriundos dos portais |
| GET | /auction/{auction_id} | Detalhes do edital |
| GET | /auction | tras lista de editais simplificada |
| GET | /auction/status | status dos editais: scope-> collect:read |
| GET | /buyer/{portal} | Lista unid. compradoras: scope-> collect:read |
| GET | /buyer/{portal}/{buyer_unit} | Lista unid. compradoras: scope-> collect:read |
| GET | /buyer/{portal}/all | Lista unid. compradoras: scope-> collect:read |
| GET | /portals | Api que ira trazer os status dos serviços para cada portal |

## Key resources

- **auctions** — tudo relacionado ao editais
- **portals** — tudo relacionado aos portais
- **buyers** — tudo relacionado as unidades compradoras
- **attachments** — tudo relacionado aos anexos
- **opened** — endpoints que nao precisa estar logado para consumir

## Why Jentic

- **Setup:** Wiring the Bidbr collector API by hand means running its OAuth2 password flow against api-login.bidbr.com.br, mapping the right ACL scopes, and handling token refresh and retries yourself. Through Jentic you install once, import the collector API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** This API puts the auction id and buyer portal in the URL path (/auction/{auction_id}, /buyer/{portal}), so a rule can pin your agent to one auction or portal: it can read that auction, its status, and buyers and nothing else. You choose the operations it may call, so writes like uploading attachments are not included unless you add them.
- **Credential handling:** Your collector API OAuth2 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.
- **Discovery method:** Agents search Jentic by intent such as 'list auctions from the portals' or 'get buyers for a portal', and Jentic returns the matching collector API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the API collector use?

The API collector uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I subir editais oriundos dos portais
 with the API collector?

Yes. Use the PUT /auction/attachments endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the API collector?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I subir editais oriundos dos portais
 through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'subir editais oriundos dos portais
'. Jentic returns the matching API collector operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the API collector have?

The API collector exposes 9 endpoints covering auctions, portals, buyers operations.

### Can I limit what my agent is allowed to do with the API collector?

Yes. API collector is called through Jentic One, which you self-host, so your own rules decide which operations and credentials the agent may use. Because the auction id and buyer portal sit in the URL path (/auction/{auction_id}, /buyer/{portal}), you can pin the agent to a single auction or portal and allow only reads, such as fetching auction details, auction status, and buyer units. Write operations like uploading attachments with PUT /auction/attachments stay out of reach unless you explicitly grant them.
