AT&T Alliance APIs

Get started with Ordering API

In this section, you’ll learn how to make your first authenticated Ordering API request and examine the response data.

1

Access

For access to the Ordering APIs, Solution Providers are requested to contact the APS API Services Team at DL-APS_API_Services@att.com. Upon reaching out, you will be guided through a process to sign a necessary agreement. Following this, Solution Providers will be provided with a unique Client ID and Client Secret. These credentials are crucial for authorization and subsequent access to the APIs.

2

Security Credentials

Once the credentials are provided, they should be included within the Header sections of any API requests. This is crucial to authorize your requests’ access. Here’s an example:

1
2
--header 'client_id: "Contact APS API Services Team for Client ID"' 
--header 'client_secret: "Contact APS API Services Team for Client secret"'
3

Sample Request

The End-Customer Lookup API, one of the Ordering APIs, allows for the retrieval of end-customer details. In the given example, details are fetched based on the zip code 70800.

1
2
3
4
5
6
7
8
9
10
{
  "accountName": "Texas",
  "address": {
    "street": "Pecan",
    "city": "Houston",
    "state": "Texas",
    "country": "USA",
    "zipCode": "70800"
  }
}
4

Associated Response

The response contains details on the end-customer and their related Alliance Status, if end-customer is found

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
[
  {
    "accountAddress": {
      "city": "TEST",
      "country": "US",
      "state": "TX",
      "street": "1234 W TEST PKWY",
      "zipCode": "123456789"
    },
    "accountName": "Test Acct",
    "accountId": "0123456789",
    "acid": "12345",
    "salesSegment": null,
    "subAccountId": "TEST1",
    "contractStatus": "Active (Remote)",
    "parentPartnerAccId": "123456",
    "partnerId": "12AB34",
    "loaStatus": "Y",
    "allianceStatus": "OPPORTUNITY",
    "accountStatus": null,
    "exception": "NA"
  },
  {
    "accountAddress": {
      "city": "TEST",
      "country": "US",
      "state": "MN",
      "street": "123 TEST AVE STE 100",
      "zipCode": "12345"
    },
    "accountName": "Test Acct 2",
    "accountId": "1234567890abcdef",
    "acid": "123123",
    "salesSegment": null,
    "subAccountId": "A1B2C",
    "contractStatus": "Active (Remote)",
    "parentPartnerAccId": "123ABC",
    "partnerId": "56CD78",
    "loaStatus": "Y",
    "allianceStatus": "OPPORTUNITY",
    "accountStatus": "Active",
    "exception": "NA"
  },
  {
    "accountAddress": {
      "city": "TEST",
      "country": "USA",
      "state": "TX",
      "street": "1234 W TEST PKWY",
      "zipCode": "123456789"
    },
    "accountName": "Test Acct 3",
    "accountId": "1234abb000000cd",
    "acid": "123A123",
    "salesSegment": "indirect sales test",
    "subAccountId": "Z9Y8X",
    "contractStatus": "Active (Remote)",
    "parentPartnerAccId": "987654",
    "partnerId": "98ZY76",
    "loaStatus": "N",
    "allianceStatus": "ATT ONLY",
    "accountStatus": "Active",
    "exception": "N"
  }
]