Visió general de l'API de Gorelo - Gorelo Documentation

Gorelo us permet integrar-vos amb qualsevol producte extern mitjançant l’API de Gorelo. L’API de Gorelo utilitza claus API. Incloeu la vostra clau a cada sol·licitud mitjançant la capçalera X-API-Key. L’URL base de Gorelo depèn de la regió que hàgiu triat per allotjar les vostres dades a Gorelo:

US
Australia

URL base: https://api.usw.gorelo.io/
Referència de l’API: https://api.usw.gorelo.io/swagger

Les pàgines d’endpoints de la referència de l’API utilitzen l’URL base dels EUA per defecte. Si les vostres dades estan allotjades a Austràlia, feu clic a l’URL base a la part superior de la pàgina de l’endpoint i seleccioneu https://api.aue.gorelo.io.

Menú de l'URL base en una pàgina d'endpoint amb https://api.aue.gorelo.io seleccionat

Exemples de sol·licituds

Els fragments següents de fetch en JavaScript mostren com autenticar-se amb la capçalera X-API-Key. Substituïu YOUR_API_KEY per la vostra clau i canvieu l’URL base per la de la regió que allotja les vostres dades.

GET

const response = await fetch('https://api.usw.gorelo.io/your-endpoint', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
  },
});

const data = await response.json();

POST

const response = await fetch('https://api.usw.gorelo.io/your-endpoint', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ key: 'value' }),
});

const data = await response.json();

Àmbits i permisos

Les claus API es poden limitar per àmbit. Si una clau no té accés a un punt final, l’API retorna 403 Forbidden. L’àmbit Documents dona a una clau accés als documents.

Camps personalitzats

Els camps personalitzats de les respostes de l’API inclouen IsSet i IsHidden. Per mantenir el valor d’un camp personalitzat fora de l’API, activeu Hide Value from API per a aquell camp.

Historial d’importació

Quan importeu registres amb un CreatedOn amb data anterior, Gorelo no envia cap notificació ni activa cap automatització.

Gorelo desa com a Completades les entrades de temps que importeu amb CreatedOn, de manera que no es facturaran. Després no les podeu modificar ni suprimir mitjançant l’API.

Gestió d’errors

Error	Significat
400 Bad Request	Entrada no vàlida o inesperada
401 Unauthorized	Clau API absent o no vàlida
403 Forbidden	Clau vàlida, àmbit insuficient
404 Not Found	El registre no existeix, o un tècnic OAuth ha intentat modificar o suprimir un registre fora dels seus grups (les claus API no es veuen afectades)
409 Conflict	La sol·licitud entra en conflicte amb l’estat del registre, com ara suprimir un contracte amb temps no facturat o temps de Block Hours
429 Too Many Requests	S’ha superat el límit de freqüència

IDs d’estat

Actius dels agents

ID	Estat
1	Instal·lant
2	En línia
3	Fora de línia
4	Supressió pendent
5	Suprimit
6	Supressió de client pendent
7	Client suprimit

Notes sobre camps i valors

Alertes

Les alertes identifiquen l’actiu al qual es refereixen amb AgentAssetId, CustomAssetId o UptimeId. Utilitzeu els mateixos camps per filtrar les alertes.

DeviceId i UptimeCheckId són àlies obsolets de AgentAssetId i UptimeId. Actualitzeu les vostres integracions perquè utilitzin els noms de camp actuals.

Contractes i factures

Camps dels contractes: Les respostes dels contractes retornen DaysUntilDue, UnitCost a les línies i AutoApproveTime a la línia de servei.
Preus de les línies de contracte: UnitPrice en una línia de contracte retorna el preu realment cobrat, no el preu del catàleg.
Línies facturables: POST /v1/invoices factura les línies No charge i Non-billable a 0. Envieu BillableStatusId 1 per a les línies que s’han de cobrar.
Impostos: Les línies de factura i de contracte sense TaxId reben l’impost que aplicaria l’aplicació. Per no facturar cap impost, envieu l’ID de la vostra taxa exempta d’impostos.
Supressió de contractes: DELETE /v1/contracts/{contractId} desactiva el contracte, com fa l’aplicació, de manera que el podeu recuperar. Per arxivar un contracte, envieu PATCH amb StatusId 3.

Tipus d’elements relacionats dels documents

El tipus d’element relacionat 4 dels documents és Agent asset. Les integracions que coincideixen per l’ID del tipus continuen funcionant. Les integracions que coincideixen pel nom del tipus han d’utilitzar Agent asset.

​Exemples de sol·licituds

​Àmbits i permisos

​Camps personalitzats

​Historial d’importació

​Gestió d’errors

​IDs d’estat

​Actius dels agents

​Notes sobre camps i valors

​Alertes

​Contractes i factures

​Tipus d’elements relacionats dels documents

Exemples de sol·licituds

Àmbits i permisos

Camps personalitzats

Historial d’importació

Gestió d’errors

IDs d’estat

Actius dels agents

Notes sobre camps i valors

Alertes

Contractes i factures

Tipus d’elements relacionats dels documents