Xero

Questo connettore fornisce accesso SQL al backend Xero.

Prima di iniziare

Prima di utilizzare il connettore Xero, svolgi i seguenti passaggi:

  • Nel tuo progetto Google Cloud:
    • Concedi il ruolo IAM roles/connectors.admin all'utente che configura il connettore.
    • Concedi i seguenti ruoli IAM all'account di servizio che vuoi utilizzare per il connettore:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un account di servizio è un tipo speciale di Account Google destinato a rappresentare un utente "non umano" che deve autenticarsi ed essere autorizzato ad accedere ai dati nelle API di Google. Se non hai un account di servizio, devi crearne uno. Per saperne di più, consulta la pagina sulla creazione di un account di servizio.

    • Abilita i seguenti servizi:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Per informazioni su come abilitare i servizi, vedi Abilitazione dei servizi.

    Se questi servizi o queste autorizzazioni non sono stati abilitati per il tuo progetto in precedenza, ti verrà chiesto di abilitarli durante la configurazione del connettore.

Configura il connettore

Per configurare il connettore è necessario creare una connessione all'origine dati (sistema di backend). Una connessione è specifica per un'origine dati. Ciò significa che se disponi di molte origini dati, devi creare una connessione separata per ciascuna. Per creare una connessione, segui questi passaggi:

  1. Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.

    Vai alla pagina Connessioni

  2. Fai clic su + Crea nuova per aprire la pagina Crea connessione.
  3. Nella sezione Posizione, scegli la località per la connessione.
    1. Regione: seleziona una località dall'elenco a discesa.

      Le regioni supportate per i connettori includono:

      Per l'elenco di tutte le regioni supportate, vedi Località.

    2. Tocca Avanti.
  4. Nella sezione Dettagli connessione, completa quanto segue:
    1. Connettore: seleziona Xero dall'elenco a discesa dei connettori disponibili.
    2. Versione connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
    3. Nel campo Nome connessione, inserisci un nome per l'istanza di connessione.

      I nomi delle connessioni devono soddisfare i seguenti criteri:

      • I nomi delle connessioni possono contenere lettere, numeri o trattini.
      • Le lettere devono essere minuscole.
      • I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
      • I nomi delle connessioni non possono superare i 63 caratteri.
    4. (Facoltativo) Inserisci una descrizione per l'istanza di connessione.
    5. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
    6. Facoltativamente, configura le impostazioni del nodo di connessione:

      • Numero minimo di nodi: inserisci il numero minimo di nodi di connessione.
      • Numero massimo di nodi: inserisci il numero massimo di nodi di connessione.

      Un nodo è un'unità (o una replica) di una connessione che elabora le transazioni. Sono necessari più nodi per elaborare più transazioni per una connessione e, al contrario, sono necessari meno nodi per elaborare un numero minore di transazioni. Per capire in che modo i nodi influiscono sui prezzi del connettore, consulta Prezzi dei nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi è impostato su 2 (per una migliore disponibilità) e il numero massimo di nodi è impostato su 50.

    7. Schema: l'API Xero a cui vuoi accedere come schema di database.
    8. Tenant: imposta l'organizzazione Xero a cui connettersi. Può essere un nome o un ID tenant.
    9. Livello di Preferenze: il livello di Preferenze di lettura per la connessione, varia da 1 a 5. Un livello di dettaglio maggiore registra tutti i dettagli delle comunicazioni (certificati di richiesta,risposta e SSL).
    10. (Facoltativo) Fai clic su + Aggiungi etichetta per aggiungere un'etichetta alla connessione sotto forma di coppia chiave-valore.
    11. Tocca Avanti.
  5. Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
    1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.

      La connessione Xero supporta i seguenti tipi di autenticazione:

      • Credenziali client OAuth 2.0
      • Concessione del codice di autorizzazione OAuth 2.0

      2. Per informazioni su come configurare questi tipi di autenticazione, vedi Configurare l'autenticazione.

    2. Tocca Avanti.
  6. Verifica: controlla i dettagli di connessione e autenticazione.
  7. Fai clic su Crea.

Configura l'autenticazione

Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.

  • Credenziali client OAuth 2.0
    • ID client: l'ID client fornito dal connettore per l'app creata.
    • Client secret: il secret di Secret Manager contenente il client secret per l'app connessa che hai creato.
  • Concessione del codice di autorizzazione OAuth 2.0
    • Token di accesso: il token di accesso utilizzato per autenticare le richieste con connessioni basate su flusso di codice di autenticazione.
    • ID client: l'ID client utilizzato per richiedere i token di accesso.
    • Client secret: il client secret utilizzato per richiedere i token di accesso.

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione è esposta come entità, operazioni e azioni.

  • Entità: un'entità può essere considerata come un oggetto o una raccolta di proprietà nell'applicazione o nel servizio collegato. La definizione di un'entità è diversa da un connettore a un connettore. Ad esempio, in un connettore di database, le tabelle sono le entità, in un connettore di file server, le cartelle sono le entità e in un connettore di sistema di messaggistica le code sono le entità.

    Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.

  • Operazione : un'operazione è l'attività che puoi eseguire su un'entità. Su un'entità puoi eseguire una qualsiasi delle seguenti operazioni:

    Se selezioni un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni delle entità dell'attività Connettori. Tuttavia, se un connettore non supporta nessuna delle operazioni delle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.

  • Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione attraverso l'interfaccia del connettore. Un'azione consente di apportare modifiche a una o più entità e di variare da connettore a connettore. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Utilizzare la connessione Xero in un'integrazione

Limitazioni di sistema

Il connettore Xero può elaborare cinque transazioni al secondo per nodo e limitare qualsiasi transazione oltre questo limite. Tuttavia, il numero di transazioni che il connettore Xero può elaborare dipende anche dai vincoli imposti dall'istanza Xero. Per maggiori informazioni, consulta la sezione Limiti di frequenza dell'API Xero. Per impostazione predefinita, Integration Connectors alloca 2 nodi (per una migliore disponibilità) per una connessione.

Per informazioni sui limiti applicabili a Integration Connectors, consulta Limiti.

Azioni

In questa sezione sono elencate alcune delle azioni supportate dal connettore. Per capire come configurare le azioni, consulta gli esempi di azioni.

Azione ScaricaAllegato

Questa azione scarica un allegato.

Parametri di input dell'azione DownloadAttachment

Nome parametro Tipo di dati Obbligatorio Descrizione
Nome del file Stringa No Nome dell'allegato da scaricare.
Tabella Stringa No Nome della tabella da cui dobbiamo scaricare l'allegato.
ObjectId Stringa No ObjectId dell'allegato.

Parametri di output dell'azione DownloadAttachment

Questa azione restituisce lo stato 200 (OK) se il download ha esito positivo.

Per capire come configurare l'azione DownloadAttachment, consulta la sezione Esempi di azioni.

Azione CaricaAllegato

Questa azione consente di caricare un allegato.

Parametri di input dell'azione UploadAttachment

Nome parametro Tipo di dati Obbligatorio Descrizione
Nome del file Stringa No Nome dell'allegato da caricare.
ObjectId Stringa No ObjectId dell'allegato.
ContentType Stringa No Tipo di contenuti dell'allegato.
Tabella Stringa No Nome della tabella in cui deve essere caricato l'allegato.
Contenuti Stringa No Contenuto dell'allegato

Parametri di output dell'azione UploadAttachment

Questa azione restituisce lo stato 200 (OK) se il caricamento dell'oggetto ha esito positivo.

Per capire come configurare l'azione UploadAttachment, consulta la sezione Esempi di azioni.

Azione ListAllegato

Questa azione consente di elencare tutti gli allegati di una tabella.

Parametri di input dell'azione ListAttachment

Nome parametro Tipo di dati Obbligatorio Descrizione
ObjectId Stringa No ID oggetto dell'allegato.
Tabella Stringa No Nome della tabella da cui devono essere elencati gli allegati.

Parametri di output dell'azione ListAttachment

Questa azione restituisce lo stato 200 (OK) se l'eliminazione ha esito positivo.

Per capire come configurare l'azione ListAttachment, consulta la sezione Esempi di azioni.

Azione SendInvoiceMail

Questa azione ti consente di inviare email a un responsabile delle fatture.

Parametri di input dell'azione SendInvoiceMail

Nome parametro Tipo di dati Obbligatorio Descrizione
InvoiceId Stringa No ID della fattura per cui deve essere inviata l'email.

Parametri di output dell'azione SendInvoiceMail

Questa azione restituisce lo stato 200 (OK) se l'operazione di spostamento ha esito positivo.

Per capire come configurare l'azione SendInvoiceMail, consulta la sezione Esempi di azioni.

Azione Carica file

Questa azione consente di caricare un file.

Parametri di input dell'azione UploadFile

Nome parametro Tipo di dati Obbligatorio Descrizione
Nome Stringa No Nome del file da caricare.
Contenuti Stringa No Contenuti del file da caricare.

Parametri di output dell'azione UploadFile

Questa azione restituisce lo stato 200 (OK) se il caricamento dell'oggetto ha esito positivo.

Per capire come configurare l'azione UploadFile, consulta la sezione Esempi di azioni.

Esempi di azioni

Questa sezione descrive come eseguire alcune delle azioni in questo connettore.

Esempio: scaricare un allegato

Questo esempio scarica un allegato.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione DownloadAttachment, quindi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value: 
    {
"Filename": "Xero_Test.txt",
"Table": "Contacts",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41"
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività di DownloadAttachment avrà un valore simile al seguente:

    [{
"Success": "True",
"Content": "Test content"
}]

Esempio: caricare un allegato

In questo esempio viene caricato un allegato.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione UploadAttachment, quindi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value: 
    {
"Filename": "Xero_Test.txt",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"ContentType": "txt",
"Table": "Contacts",
"Content": "Test content upload attachment"
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività di UploadAttachment avrà un valore simile al seguente:

    [{
"Success": null,
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Test.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27",
"IncludeOnline": null,
"_": ""
}, {
"Success": null,
"AttachmentId": null,
"FileName": null,
"URL": null,
"MimeType": null,
"ContentLength": null,
"IncludeOnline": null,
"_": null
}]

Esempio: elenco di allegati

In questo esempio sono elencati gli allegati della tabella specificata.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione ListAttachment, quindi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value: 
    {
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"Table": "Contacts"
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività di ListAttachment avrà un valore simile al seguente:

    [{
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Limit_Testing.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27"
}]

Esempio: inviare una fattura via email

In questo esempio viene inviata un'email per la fattura specificata.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione SendInvoiceMail, quindi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value: 
    {
"InvoiceId": "016a64c7-be0b-45a2-acae-13057fdf1566"
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività di SendInvoiceMail avrà un valore simile al seguente:

    [{
"Success": "true"
}]

Esempio: caricamento di un file

In questo esempio viene caricato un file.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione UploadFile, quindi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value: 
    {
"Name": "Sample1.txt",
"Content": "This is a sample file"
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività di UploadFile avrà un valore simile al seguente:

    [{
"Success": "true",
"FileId": "09039c7b-35a2-473d-aa79-16fe00b8d460",
"Name": "Sample1.txt",
"FolderId": "36e5115d-a9b6-4c22-baf3-40a8b28ee71d",
"MimeType": "text/plain",
"Size": 26.0,
"User_Id": "c1e33cc9-eb61-45cb-9e46-3ea4121cbdc6",
"User_Name": "test_user_1@test.com",
"User_FirstName": "John",
"User_LastName": "Smith",
"User_FullName": "John Smith",
"Created": "2023-12-18 17:38:53.01",
"Updated": "2023-12-18 17:38:53.01"
}]

Esempi di operazioni sull'entità

Questa sezione mostra come eseguire alcune delle operazioni sulle entità in questo connettore.

Esempio: elenco di tutti i record

In questo esempio sono elencati tutti i record dell'entità Accounts.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Accounts dall'elenco Entity.
  3. Seleziona l'operazione List, quindi fai clic su Fine.
  4. Facoltativamente, nella sezione Input attività dell'attività Connettori, puoi filtrare il set di risultati specificando una clausola di filtro. Ad esempio: City='Bangalore'. Puoi anche specificare più condizioni di filtro utilizzando gli operatori logici. Ad esempio, City='Bangalore' and region='asia-south2'.

Esempio: ricezione di una fattura

Questo esempio riceve una fattura con l'ID specificato dall'entità Invoices.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Invoices dall'elenco Entity.
  3. Seleziona l'operazione Get, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su EntityId e inserisci 1|016a64c7-be0b-45a2-acae-13057fdf1566 nel campo Valore predefinito.

    In questo caso, 1|016a64c7-be0b-45a2-acae-13057fdf1566 è un valore di chiave primaria nell'entità Invoices.

Esempio: creare una fattura

In questo esempio viene creata una fattura nell'entità Invoices.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Invoices dall'elenco Entity.
  3. Seleziona l'operazione Create, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value: 
    {
"Type": "ACCPAY",
"ContactName": "ContactName1",
"LineItem_Description": "LineItemDescription"
}

    Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

    {
"Id": "1|7b29efe9-dacd-47bb-85a6-0c0640ce25de"
}

Esempio: aggiornamento di un record

Questo esempio aggiorna un record nell'entità AssetTypes.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona AssetTypes dall'elenco Entity.
  3. Seleziona l'operazione Update, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value: 
    {
"BookDepreciationSetting_DepreciationRate": 10.0
}
  5. Fai clic su entityId, quindi inserisci f8d43548-25b0-4cc3-8f59-d97106974fe8 nel campo Default Value (Valore predefinito).

    Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

    {
"AssetTypeId": "f8d43548-25b0-4cc3-8f59-d97106974fe8"
}

Esempio: eliminare un file

Questo esempio elimina il file con l'ID specificato dall'entità Files.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Files dall'elenco Entity.
  3. Seleziona l'operazione Delete, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId, quindi inserisci 421c82f0-38fb-4074-a679-63b04c0d8832 nel campo Valore predefinito.

Dopo aver creato la connessione, diventa disponibile sia in Apigee Integration che in Application Integration. Puoi usare la connessione in un'integrazione tramite l'attività Connettori.

  • Per capire come creare e utilizzare l'attività Connettori in Apigee Integration, consulta Attività Connettori.
  • Per capire come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Ricevi assistenza dalla community Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore nella community Google Cloud sui forum Cloud.

Passaggi successivi