El código de autorización de API (API_TOKEN) se obtiene desde la configuración de la aplicación: Configuración > API > Código de autorización API. Gracias a él, no necesitarás proporcionar tu usuario/contraseña en las llamadas API.

Ejemplos de uso

Agregar un nuevo cliente

curl http://YOUR-PREFIX.sugester.pl/app/clients.json\
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '
{
"api_token": "YOUR_API_TOKEN",
"client": {
    "name":"client 1 from API",
    "email": "[email protected]",
    "note": "note 1"
  }
}'

Obtener datos de todos los clientes

curl http://YOUR-PREFIX.sugester.pl/app/clients.json?api_token=YOUR_API_TOKEN

Obtener datos de un cliente

curl http://YOUR-PREFIX.sugester.pl/app/clients/1234.json?api_token=YOUR_API_TOKEN

Actualizar datos del cliente

curl http://YOUR-PREFIX.sugester.pl/app/clients/1234.json\
     -X PUT \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '
{
"api_token": "YOUR_API_TOKEN",
"client": {
    "note": "note from API"
  }
}'

Eliminar un cliente

curl -X DELETE  http://YOUR-PREFIX.sugester.pl/app/clients/12345.json?api_token=YOUR_API_TOKEN

Agregar una nueva tarea

curl http://YOUR-PREFIX.sugester.pl/app/posts.json \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '
{
"api_token": "YOUR_API_TOKEN",
"post": {
    "title":"task title 1 from API",
    "content": "task content 1",
    "task_kind": "task",
    "client_id": null,
    "responsible_id": 1234
  }
}'

Obtener datos de todas las tareas (del helpdesk)

curl http://YOUR-PREFIX.sugester.pl/app.json?api_token=YOUR_API_TOKEN

Obtener datos de una tarea

curl http://YOUR-PREFIX.sugester.pl/app/posts/1234.json?api_token=YOUR_API_TOKEN

Agregar un comentario a la tarea con id post_id

curl http://YOUR-PREFIX.sugester.pl/app/posts.json \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '
{
"api_token": "YOUR_API_TOKEN",
"post": {
    "post_id": 123,
    "title":"comment for task 123",
    "content": "comment content 1",
    "task_kind": "comment",
    "client_id": null,
    "responsible_id": 1234
  }
}'

Agregar un nuevo negocio

curl http://YOUR-PREFIX.sugester.pl/app/deals.json\
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '
{
"api_token": "YOUR_API_TOKEN",
"deal": {
    "name":"deal 1 from API",
    "description": "desc 1",
    "client_id": null
  }
}'

Actualizar negocio

curl http://YOUR_PREFIX.sugester.pl/app/deals/1234.json\
    -X PUT \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '
{
"api_token": "YOUR_API_TOKEN",
"deal": {
   "description": "new description from API"
 }
}'

Obtener datos de todos los negocios

curl http://YOUR-PREFIX.sugester.pl/app/deals.json?api_token=YOUR_API_TOKEN

Obtener datos del negocio

curl http://YOUR-PREFIX.sugester.pl/app/deals/1234.json?api_token=YOUR_API_TOKEN

Eliminar un negocio

curl -X DELETE  http://YOUR-PREFIX.sugester.pl/app/deals/12345.json?api_token=YOUR_API_TOKEN

Agregar un contacto

curl http://YOUR_PREFIX.sugester.pl/app/contacts.json\
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '
{
"api_token": "YOUR_API_TOKEN",
"contact": {
   "name":"contact 1 from API",
   "description": "new contact from API",
   "first_name": "John",
   "last_name": "Doe",
   "responsible_id": 1,
   "email": "[email protected]",
   "phone": "123456789"
 }
}'

Obtener datos del contacto

curl http://YOUR-PREFIX.sugester.pl/app/contacts/1234.json?api_token=YOUR_API_TOKEN

Actualizar datos del contacto

curl http://YOUR_PREFIX.sugester.pl/app/contacts/1234.json\
    -X PUT \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '
{
"api_token": "YOUR_API_TOKEN",
"contact": {
   "description": "new description from API"
 }
}'

Agregar una lista de destinatarios

curl https://YOUR_PREFIX.sugester.pl/app/contact_lists.json \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '
{
"api_token": "YOUR_API_KEY",
"contact_list": {
    "name": "New contact list"
  }
}'

Obtener datos de la lista de destinatarios

curl https://YOUR_PREFIX.sugester.pl/app/contact_lists/10.json?api_token=YOUR_API_TOKEN

Actualizar datos de la lista de destinatarios

curl https://YOUR_PREFIX.sugester.pl/app/contact_lists/10.json \
     -X PUT \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '
{
"api_token": "YOUR_API_TOKEN",
"contact_list": {
    "name": "New contact list updated"
  }
}'

Agregar un post de tipo "error"

curl http://your-prefix.sugester.pl/app/posts.json \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '
{
"api_token": "API_TOKEN",
"post": {
    "title":"post title2",
    "content": "post content 2",
    "kind": "error"
  }
}'

Agregar una nueva cuenta

curl http://YOUR-PREFIX.sugester.pl/app/account.json \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '
{
"api_token": "YOUR_API_TOKEN",
"account": {
    "prefix":"sugester2",
    "initial_module": "crm",
    "from_partner": "partner1"
 },
"user": {
    "login": "login1",
    "email": "[email protected]",
    "password": "password1"
 }
}'

Integraciones

Agregar un nuevo cliente

curl https://YOUR_PREFIX.sugester.pl/app/clients.json \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '
{
"api_token": "YOUR_API_TOKEN",
"client": {
    "name": "client 2 from External APP via API",
    "email": "[email protected]",
    "note": "note ext 2",
    "external_ids": {
        "myapp_client_id": "17"
    }
  }
}'

Agregar un nuevo negocio

curl https://YOUR_PREFIX.sugester.pl/app/deals.json \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '
{
"api_token": "YOUR_API_TOKEN",
"deal": {
    "name": "deal 2 from External APP via API",
    "description": "desc 2",
    "price": 117,
    "client": {
        "name": "client 2 from External APP via API",
        "email": "[email protected]",
        "external_ids": {
            "myapp_client_id": "17"
        }
    },
    "external_ids": {
        "myapp_invoice_id": "21"
    }
  }
}'

Especificación de campos del Cliente

{
	"id": id del cliente
	"name": nombre del cliente
	"tax_no": número de identificación fiscal
	"post_code": código postal
	"city": ciudad
	"street": calle
	"first_name": nombre
	"country": país
	"email": correo electrónico
	"phone": teléfono
	"www": sitio web
	"fax": fax
	"created_at": fecha de creación
	"updated_at": fecha de actualización
	"street_no": número de calle
	"kind": tipo (buyer/seller)
	"bank": nombre del banco
	"bank_account": cuenta bancaria
	"bank_account_id":
	"shortcut": abreviatura del nombre
	"note": nota
	"last_name": apellido
	"discount": descuento
	"payment_to_kind": plazo de pago predeterminado
	"use_delivery_address": dirección de envío activa
	"delivery_address": dirección de envío
	"mobile_phone": teléfono móvil
	"company": es empresa
	"register_number": número de registro
	"description": descripción
	"project_id": id del proyecto
	"contact_id": id del contacto principal
	"appendixes_count": cantidad de adjuntos
	"posts_count": cantidad de correos/tareas
	"contacts_count": cantidad de contactos
	"last_activity": última actividad
	"string1..10": campos adicionales
	"integer1..10": campos adicionales
	"decimal1..10": campos adicionales
	"checkbox1..10": campos adicionales
	"date1..10": campos adicionales
	"text1..10": campos adicionales
	"datetime1..10": campos adicionales
	"avatar_file_name": avatar
	"avatar_content_type"
	"avatar_file_size"
	"avatar_updated_at"
	"status_id": id del estado
	"category_id": id de la categoría
	"department_id": id del departamento
	"position": posición
	"creator_id": id del creador
	"updater_id": id del último actualizador
	"responsible_id": id del responsable
	"province": provincia/estado
	"sensitive_data": datos sensibles ocultos
	"external_id": ID externo del cliente
	"token": token del cliente
	"paid_from": pagado desde
	"paid_to": pagado hasta
	"paid_total": total de pagos del cliente
}

Especificación de campos del Post (Tarea/Sugerencia/Reporte/Correo)

{
    "id": id del post
    "title": título
    "content": contenido
    "kind": tipo de sugerencia (suggestion, error, question, praise, private)
    "user_id": id del usuario
    "points": cantidad de puntos
    "nick": nick del usuario
    "votes_cache": cantidad de votos
    "comments_cache": cantidad de comentarios
    "forum_id": id del foro
    "category_id": id de la categoría
    "created_at": fecha de creación
    "updated_at": fecha de última modificación
    "ip": dirección IP
    "agent": info del navegador
    "response": respuesta principal
    "response_user_id": id del que respondió
    "referrer": referrer
    "responsible_id": id del asignado
    "last_action_status": estado
    "email": email del remitente
    "uid": token del usuario
    "spam_kind": tipo de spam
    "answer": respuesta
    "answered": tiene respuesta
    "duplicate_from_id": id del duplicado
    "abstract": resumen
    "status_id": id del estado
    "view_count": cantidad de visualizaciones
    "tags": etiquetas
    "facebook_likes": cantidad de likes en Facebook
    "min_votes_to_start": votos necesarios para iniciar
    "use_html": es HTML
    "email_to": dirección email destinatario
    "email_cc": email cc
    "email_bcc": email bcc
    "spam_score": puntuación de spam
    "spam_report": informe de spam
    "closed": está cerrado (true/false)
    "scheduled_at": fecha programada
    "task_kind": tipo de tarea (feedback, email, task, help, chat, phone, lead, error, idea)
    "priority": prioridad
    "title_note": null
    "user_spam_report": reporte de spam
    "client_id": id del cliente
    "project_id": id del proyecto
    "help_link": clave del enlace de ayuda
    "help_content": contenido de ayuda
    "post_id": id del post padre
    "www": sitio web del autor
    "private": es privado (true/false)
    "unread": no leído (true/false)
    "email_recipient": destinatario (helpdesk/mail)
    "email_reply_to": responder a (helpdesk/mail)
}