Saltar al contenido principal

Empezar con la APIPrimera llamada

Primera llamada

Crea una clave, confirma GET /me y crea el primer contacto en el mismo workspace.

GET/api/v1/me

Cuatro pasos. Si el último devuelve 200, la integración está viva — aunque el workspace aún no tenga filas.

  1. En el producto: Settings → Developer → Create API key.
  2. Concede REST, al menos Contacts: Write (rest.crm.contacts.write). Write implica read en el mismo recurso.
  3. Copia el secreto aivk_… — aparece una vez.
  4. Llama al host público con Authorization: Bearer aivk_…

Host

Un host público. No envíes tráfico de integrador a app.aivyro.io (UI) ni a api.internal.aivyro.io (mesh privado).

Confirma la clave

HTTPPathScope
GET/api/v1/meaivk_
GET /api/v1/me
export AIVYRO_API_KEY='aivk_YOUR_KEY'
export AIVYRO_API_BASE='https://api.aivyro.io'

curl -sS "$AIVYRO_API_BASE/api/v1/me" \
  -H "Authorization: Bearer $AIVYRO_API_KEY"

Crea un contacto y lista

POST + GET /api/v1/contacts
curl -sS -X POST "$AIVYRO_API_BASE/api/v1/contacts" \
  -H "Authorization: Bearer $AIVYRO_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"display_name":"Ada Lovelace","email":"ada@example.com"}'

curl -sS "$AIVYRO_API_BASE/api/v1/contacts" \
  -H "Authorization: Bearer $AIVYRO_API_KEY"

Un workspace vacío devuelve { "data": [], "next_cursor": null, "has_more": false }. Eso es éxito. El contacto creado aparece en Contactos de la misma organización.

Contrato máquina

GET /api/v1/openapi.json es el contrato de rutas, paginación y errores. En algunos hosts el endpoint pide la misma clave Bearer. Si este sitio y el OpenAPI discrepan, ganan el OpenAPI y el host — y la guía es la que debe corregirse.