La API de Atera ofrece múltiples métodos para integrar y extender la funcionalidad de Atera. Utilice nuestra API para integrarse fácilmente con su sistema de contabilidad, mejorar la productividad de su equipo y crear integraciones perfectas.
Su cuenta está protegida por una clave de acceso API única (REST API). Debe iniciar sesión con esta clave para utilizar la API de Atera.
Nota: Atera admite solicitudes de API a través de HTTPS solamente..
Revela tu clave API de Atera
Para revelar tu clave API:
1. Desde Admin, en el panel lateral, haz clic en API.
Aparece la página API.
3. Haz clic en el icono del ojo para revelar su clave API.
Nota:Usted tendrá que proporcionar esta clave con cada solicitud que haga a Atera API. Por favor, mantén esta clave secreta y segura ya que expone tus contactos y sus dispositivos. Si necesita restablecer su clave por cualquier motivo, haga clic en Restablecer mi clave de API (el restablecimiento de la clave de API hará que cualquier solicitud realizada con la clave anterior falle).
Inicia sesión con tu clave API de Atera
Para iniciar sesión con tu clave API:
1. Desde Admin, en el panel lateral, haz clic en API.
Aparece la página API.
2. Haga clic en Ver documentación. La página de documentación de Atera API se abrirá en una nueva pestaña.
3. Haga clic en Iniciar sesión, en la parte superior derecha de la página. Aparece la ventana Autorizaciones disponibles.
4. Introduzca su clave API. A continuación, haga clic en Autorizar.
La API le da acceso a muchos tipos de datos, incluyendo:
| Agentes | MachineID, AgentID, DeviceGUID, FolderID, CustomerID, CustomerName, etc. |
| Alertas | AlertID, Code, Source, Title, Severity, Created, SnoozedEndDate, etc. |
| Facturación | InvoiceID, InvoiceNumber, InvoiceNumberAsString, Total, Subtotal, Tax, etc. |
| Contactos | EndUserID, CustomerID, CustomerName, JobTitle, Email, Phone, etc. |
| Contratos | CustomerID, ContractName, ContractType, Active, Taxable, StartDate, etc. |
| Clientes | CustomerID, CustomerName, CreatedOn, LastModified, Domain, Address, etc. |
| Valores personalizados | ItemID, ID, FieldName, ValueAsString, ValueAsDecimal, ValueAsBool, etc. |
| Dispositivo | Name, DeviceID, DeviceGuid, CustomerID, CustomerName, MntrngAgentID etc. |
| BaseConocimiento | KBID, KBTimestamp, KBContext, KBProduct, KBLastModified, etc. |
| Tarifas | RateID, Amount, Description, SKU, and Category. |
| Entradas | TicketID, TicketTitle, EndUserID, EndUserEmail, TicketResolvedDate, etc. |
Ejemplos
- Solicitar información sobre agentes
- Solicitar información de clientes
- Actualizar un cliente concreto.
Para obtener la lista de Agentes como una cadena curl:
1. Ir a https://app.atera.com/apidocs. Se carga la página de la API de Atera. Si aún no lo has hecho, entrar
2. Haga clic en Agente. Se despliegan los métodos Agente.
3. Haz clic en GET /api/v3/agents.;
4. Haga clic en ¡Pruébelo! Se generará el rizo.
El cuerpo de la respuesta muestra la información de cada agente.
Para obtener la lista de Clientes como una cadena curl:
1. Ir a https://app.atera.com/apidocs. Se carga la página de la API de Atera. Si aún no lo has hecho, entrar
2. Haga clic en Cliente.
3. Haz clic en GET /api/v3/customers.
4. Haz clic en ¡Pruébalo! Curl se generará.
El cuerpo de la respuesta muestra una lista de todos los clientes y su información asociada;
Para actualizar un cliente:
Nota: Para implementar correctamente esta llamada al método PUT, necesitará el ID del cliente. Echa un vistazo a nuestro ejemplo anterior, o echa un vistazo a tu URL cuando estés en la página específica de Cliente.
1. Ir a https://app.atera.com/apidocs. Se carga la página de la API de Atera. Si aún no lo has hecho, entrar
2. Haga clic en Cliente.
3. Haz clic en PUT /api/v3/customers/{customerID}.
4. Introduzca el ID de cliente.
5. Haga clic en cualquier parte del cuadro de la parte derecha de la página para rellenar el campo del cliente.
6. Realice los cambios que desee.
7. Haga clic en Probar. Curl generará.
Se actualiza el cliente. El cuerpo de la respuesta indica qué cliente se ha actualizado y el código de respuesta indica que se ha realizado correctamente.
