canonical: https://jentic.com/apis/integracionplanok.io/integracionplanok

# Integracionplanok API REST

Jentic publishes the only available OpenAPI specification for the Planok GCI REST API, keeping it validated and agent-ready. Planok's GCI integration API is a 206-endpoint platform used by real-estate developers in Latin America to manage owner registration, property reservations, payment channels, and post-sale workflows for new construction projects. The surface covers owner onboarding ('guia'), online reservations, payment connectors such as Webpay, Visanet, and Iconstruye, plus WhatsApp notification hooks. Several apiKey-style schemes are in play (query keys, header keys, JWT, and a Cognito JWT) - pick the one your registered application is provisioned for.

## For AI agents

Drive Planok GCI workflows for Latin American real-estate developers - owner registration, property reservations, payment channels, and post-sale notifications.

## Scope

Does not handle generic CRM contact records, accounting ledgers, or marketing email campaigns - use for Planok owner, reservation, and payment-channel workflows only.

## Capabilities

- Register and manage property owners through the /guia owner-onboarding endpoints
- Send and resend validation codes and confirmation emails to owners
- Reset owner passwords and force password changes via /guia/cambiar-password and /guia/set-force-change-pass
- Create and read online property reservations under the 'Reserva En Línea' tag
- Trigger payments through Webpay, Visanet, Iconstruye, and Pok Pagos channel endpoints
- Push WhatsApp notifications via the Whatsapp tag endpoints
- Look up property metadata such as cities ('ciudades') and channels ('canales')

## Use cases

### Owner Onboarding for a New Project

When a new buyer purchases a unit, register them as an owner via POST /guia/registro-inicial-propietario, send a validation code, and confirm their email through /guia/confirmar-correo-propietario. The /guia endpoints model the full Planok onboarding flow used by Latin American developers, so an automation can drive sign-up end-to-end without operators copy-pasting between systems.

Example prompt: POST /guia/registro-inicial-propietario with the owner identifier, then trigger /guia/re-enviar-codigo-validacion if confirmation is delayed.

### Online Reservation with Payment

Combine the 'Reserva En Línea' endpoints with the Webpay or Visanet channel endpoints to capture an online reservation and immediately collect payment. The flow stores the reservation, returns a Planok reservation id, and posts the payment through the right channel, removing the manual pairing step in the Planok back-office.

Example prompt: Create a reservation under 'Reserva En Línea', then call the Webpay channel endpoint with the reservation id and amount to collect payment.

### WhatsApp Notification for Reservation Updates

Trigger WhatsApp notifications via the Whatsapp tag endpoints whenever a reservation changes state, so buyers get real-time updates on installments, document approvals, or handover dates. This avoids relying on email alone in markets where WhatsApp is the primary channel.

Example prompt: Send a WhatsApp notification through the configured Planok endpoint when a reservation transitions to 'paid'.

### AI Agent Real-Estate Operator via Jentic

An AI agent given access to Planok through Jentic can take a buyer through registration, reservation, and payment in one conversation. Jentic handles the multi-scheme apiKey isolation and exposes each Planok operation by intent, so the agent navigates 206 endpoints without reading the docs.

Example prompt: Through Jentic, register the buyer via planok_register_owner, create the reservation via planok_create_reservation, and trigger the Webpay payment via the payment-channel operation.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /guia/registro-inicial-propietario | Register a new property owner |
| POST | /guia/confirmar-correo-propietario | Confirm an owner's email |
| POST | /guia/re-enviar-codigo-validacion | Resend the owner validation code |
| POST | /guia/cambiar-password | Change an owner's password |
| GET | /guia/trae-estado-propietario | Get an owner's current state |
| POST | /guia/preguntas-frecuentes | Submit a frequently-asked-question request |

## Key resources

- **Guia (Owners)** — Owner registration, validation, password, and state management.
- **Reserva En Línea** — Online property reservations against a project unit.
- **CanalesPago** — Payment channel routing across providers.
- **Webpay** — Webpay payment integration endpoints.
- **Visanet** — Visanet payment integration endpoints.
- **Iconstruye** — Iconstruye installment and procurement payments.
- **Pok Pagos** — Internal Planok payment processing endpoints.
- **Whatsapp** — WhatsApp notification triggers for reservation events.
- **Ciudades / Canales** — Reference data lookups for cities and channels.

## Why Jentic

- **Setup:** Wiring the Planok GCI REST API by hand means setting up its multiple apiKey schemes across query and header locations and binding each to the right parameter across 206 endpoints. Through Jentic you install once, import the Planok GCI REST API from the API Directory, store the keys once, and your agent calls it.
- **Permission scoping:** Planok routes owner, reservation, and payment-channel actions through request bodies on paths like /guia/registro-inicial-propietario, so limit the agent to the operations it needs, such as registering an owner or checking owner status, rather than to one record. You choose the operations it may call, so password changes are not included unless you add them.
- **Credential handling:** Your Planok apiKey values are stored once, encrypted, by your own Jentic One instance and bound to the right query or header parameter at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'register a Planok owner' or 'create a property reservation', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **HubSpot CRM Deals API** — HubSpot CRM Deals tracks the sales pipeline for property buyers alongside Planok reservations.
- **Salesforce API** — Salesforce can hold the contact and pipeline records that Planok references for owners.
- **Instamojo Payments API** — Instamojo offers a generic payment-request API in markets where Webpay and Visanet are not used.

## FAQ

### Why is there no official OpenAPI spec for the Planok GCI API?

Planok does not publish an OpenAPI specification for the GCI integration API. Jentic generates and maintains this spec so that AI agents and developers can call API REST via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Planok GCI API use?

The spec defines several apiKey-style schemes: APIKey (query parameter 'apikey'), APIKeyPublic (header 'xApiKeyPublic'), JWT (Authorization header), XAPIKey (header 'X-API-KEY'), CognitoJWT (header 'Token'), NotificacionPush (query 'codigoAplicacion'), and Planok (query 'sharedSecret'). Endpoints declare which scheme they require, so use the one your client application is provisioned for. Through Jentic, all of these credentials are held in your encrypted Jentic One instance.

### Can I create online property reservations through this API?

Yes. The 'Reserva En Línea' tag groups the online-reservation endpoints, which create and read reservations against project units. Combine these with the channel-specific endpoints (Webpay, Visanet, Iconstruye, Pok Pagos) to take payment alongside the reservation.

### What are the rate limits for the Planok GCI API?

The OpenAPI specification does not encode explicit rate limits. Owner-onboarding and reservation endpoints are typically driven by user actions, so design around per-event calls, paginate any list endpoints, and back off on 429 responses returned by the gateway.

### How do I register a property owner through Jentic?

Install with pip install jentic, then run the search-load-execute flow with the query 'register a Planok property owner'. Jentic returns the operation backed by POST /guia/registro-inicial-propietario; the agent supplies the owner identifier and any required project context.

### Can the API send WhatsApp notifications?

Yes. The 'Whatsapp' tag groups endpoints that trigger WhatsApp notifications on reservation events. They are intended to keep buyers updated on installments and document state on a channel that dominates messaging in many Latin American markets.

### Can I limit what my agent is allowed to do with the Planok GCI REST API?

Yes. Because you run Jentic One yourself, your own rules decide which Planok operations and API keys the agent may use, so you can grant just the endpoints a task needs, such as registering an owner via /guia/registro-inicial-propietario or checking owner status, and withhold the rest. Sensitive actions like password changes on /guia/cambiar-password stay off the agent's list unless you explicitly add them, and you can likewise scope whether it may trigger payment channels such as Webpay, Visanet, or Iconstruye. The keys are bound to the right query or header parameter at execution time, so the agent only ever calls the operations you allow.