首页 > 解决方案 > Xero 会计 API GetContactsAsync 未授权 + 联系人不包含“GetEnumerator”错误的公共实例定义

问题描述

我一直在尝试学习如何使用 Account API,并决定下载并使用文档中提供的 XeroOAuth2Sample。(https://github.com/XeroAPI/xero-netstandard-oauth2-samples

因此,在 HomeController.cs 中有一个示例 HTTPGet 方法,用于从 Xero 文档提供的 API 中检索发票总数。代码如下:

[HttpGet]
        [Authorize]
        public async Task<IActionResult> OutstandingInvoices()
        {
            var token = await _tokenStore.GetAccessTokenAsync(User.XeroUserId());

            var connections = await _xeroClient.GetConnectionsAsync(token);

            if (!connections.Any())
            {
                return RedirectToAction("NoTenants");
            }

            var data = new Dictionary<string, int>();

            foreach (var connection in connections)
            {
                var accessToken = token.AccessToken;
                var tenantId = connection.TenantId.ToString();

                var organisations = await _accountingApi.GetOrganisationsAsync(accessToken, tenantId);
                var organisationName = organisations._Organisations[0].Name;

                var outstandingInvoices = await _accountingApi.GetInvoicesAsync(accessToken, tenantId, statuses: new List<string>{"AUTHORISED"}, where: "Type == \"ACCREC\"");

                data[organisationName] = outstandingInvoices._Invoices.Count;
            }

            var model = new OutstandingInvoicesViewModel
            {
                Name = $"{User.FindFirstValue(ClaimTypes.GivenName)} {User.FindFirstValue(ClaimTypes.Surname)}",
                Data = data
            };

            return View(model);
        }

所以我一直在尝试通过创建一个最终从 API 端点调用联系人的页面来练习和探索 API。我创建了一个 Contact.cs 模型类,如下所示:

public class Contact
    {
        public string ContactID { get; set; }
        public string ContactStatus { get; set; }
        public string Name { get; set; }
        public string FirstName { get; set; }
        public string LastName { get; set; }
        public string EmailAddress { get; set; }
        public string SkypeUserName { get; set; }
        public string BankAccountDetails { get; set; }
        public string TaxNumber { get; set; }
        public string AccountsReceivableTaxType { get; set; }
        public string AccountsPayableTaxType { get; set; }
        public List<Address> Addresses { get; set; }
        public List<Phone> Phones { get; set; }
        public DateTime UpdatedDateUTC { get; set; }
        public bool IsSupplier { get; set; }
        public bool IsCustomer { get; set; }
        public string DefaultCurrency { get; set; }
    }

然后,我创建了一个 ContactViewModel.cs,它具有我希望稍后在我的 Razor 视图页面上显示的属性,代码如下:

public class ContactViewModel
    {
        public string ContactID { get; set; }
        public string ContactStatus { get; set; }
        public string Name { get; set; }
        public string FirstName { get; set; }
        public string LastName { get; set; }
        public bool IsSupplier { get; set; }
        public bool IsCustomer { get; set; }
        public string DefaultCurrency { get; set; }
    }

然后,我有我的 ContactsViewModel,它是 ContactViewModel 中的联系人列表:

public class ContactsViewModel
    {
        public List<ContactViewModel> Contacts { get; set; }
    }

因此,当我尝试为我的联系人发出/调用 HTTPGet 请求时,我的问题出现了,代码如下:

[HttpGet]
        [Authorize]
        public async Task<IActionResult> Contacts()
        {
            var token = await _tokenStore.GetAccessTokenAsync(User.XeroUserId());

            var connections = await _xeroClient.GetConnectionsAsync(token);

            if (!connections.Any())
            {
                return RedirectToAction("NoContacts");
            }   

            foreach (var connection in connections)
            {
                var accessToken = token.AccessToken;
                var tenantId = connection.TenantId.ToString();

                var contactList = await _accountingApi.GetContactsAsync(accessToken, tenantId);

                List<ContactsViewModel> contacts = new List<ContactsViewModel>();

                foreach (var contact in contactList)
                {
                    contacts.Add(new ContactViewModel
                    {
                        ContactID = contact.ContactID,
                        ContactStatus = contact.ContactStatus,
                        Name = contact.Name,
                        FirstName = contact.FirstName,
                        LastName = contact.LastName,
                        IsSupplier = contact.IsSupplier,
                        IsCustomer = contact.IsCustomer

                    });
                }
                contacts.AddRange(contactList);
            }
            var model = new ContactsViewModel()
            {
                //  Contacts = contacts
            };
            return View(model);

        }

所以第一个错误如下:

ApiException: Error calling GetContacts: {"title":"Unauthorized","status":401,"detail":"AuthorizationUnsuccessful","instance":"354ff497-d29f-468b-9e1c-4345e9ce8123"}

从“GetContactsAsync”方法返回:

var contactList = await _accountingApi.GetContactsAsync(accessToken, tenantId);

我不确定是否有我遗漏的特定值我也需要传递导致此错误?我在 Xero 文档中找不到任何关于此的内容。尽管将鼠标悬停在 GetcontactsAsync 上会显示此信息以获取更多信息:

(awaitable) Task<Xero.NetStandard.OAuth2.Model.Contacts> IAccountingApiAsync.GetContactsAsync(string accessToken, stringXeroTenantId, [System.DateTime? ifModifiedSince = null], [string where = null], [string order = null], [List<System.Guid> iDs = null], [int? page = null], [bool? includeArchived = null])

最后,contactList 似乎会抛出有关“GetEnumerator”的标题所暗示的错误,并且当使用 AddRange 将联系人添加到 contactsList 时,会显示此错误

cannot convert from 'Xero.NetStandard.OAuth2.Model.Contacts' to 'System.Collections.Generic.IEnumerable<XeroOAuth2Sample.Models.ContactsViewModel>'

GetContactsAsync 中是否有我明显遗漏的东西?提前感谢您的阅读和帮助。

标签: c#asp.net-mvcasp.net-corexero-api

解决方案


与示例中要求的默认范围相比,联系人端点需要额外的 OAuth2.0 范围。您可以在此处查看示例使用的范围集:https ://github.com/XeroAPI/xero-netstandard-oauth2-samples/blob/master/XeroOAuth2Sample/XeroOAuth2Sample/Startup.cs#L105L106

您可以在我们的文档中查看完整的范围集:https ://developer.xero.com/documentation/oauth2/scopes

对于您的情况,您需要使用 accounting.contacts 或 accounting.contacts.read 范围来读取联系人,或者如果最终要更新/创建联系人,则需要使用 accounting.contacts 范围

编辑:如果您只想阅读联系人,您需要请求并让用户同意accounting.contacts.read 范围。如果您想更新/创建联系人,您需要请求并让用户同意accounting.contacts 范围。accounting.contacts 范围将允许读写访问


推荐阅读