aom.scripting.eso

Interface ZoneAccessService

public interface ZoneAccessService

This is an interface specifying what functionality the Zone Access Service offers. Most of this functionality is offered by the zoneaccessapi.dll, respectively zoneaccessx.dll file for AoM and AoT.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Note

There are two different services for AoM and AoT respectively, although they look almost identical.

Typical login sequence:

1. Check for updates
2. Get config file
3. Get string table
4. Get match schema
5. ZoneAccessService.GetConfig
6. Passport login
7. ZoneAccessService.GetMasterTicket
8. ZoneAccessService.ActivateProductKey
9. ZoneAccessService.GetCDKeyTicket
10. ZoneAccessService.GetServiceTicket (LegacyAuth)
11. AccountService.Authenticate
12. ZoneAccessService.RegisterNickname
13. Retrieve stats from Stats Server
14. Get config file (again)
15. Get message of the day
16. ZoneAccessService.GetServiceTicket (Stats)

See Also:

Zone Access Service, Zone Access Service WSDL

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ZoneAccessService.GetMasterAndServiceTicketsRequest
static class	ZoneAccessService.GetMasterAndServiceTicketsResponse
static class	ZoneAccessService.StatusCodeResult A status code indicating the result of the requested operation.
static class	ZoneAccessService.XMLBlobResult A blob of XML code, accompanied by a status code.

Method Summary

Modifier and Type	Method and Description
ZoneAccessService.StatusCodeResult	ActivateProductKey(String gameID, String masterTicket, String strDigitalPid) Register a product key.
ZoneAccessService.XMLBlobResult	GetCDKeyTicket(String gameID, String serviceID, String masterTicket, String strDigitalPid) Get a CDKey Ticket
ZoneAccessService.XMLBlobResult	GetConfig(String gameID) Return configuration details about a game title.
ZoneAccessService.GetMasterAndServiceTicketsResponse	GetMasterAndServiceTickets(ZoneAccessService.GetMasterAndServiceTicketsRequest request) Get A Master Ticket and Multiple Service Tickets (0-N).
ZoneAccessService.XMLBlobResult	GetMasterTicket(String gameID) Get a master ticket.
ZoneAccessService.XMLBlobResult	GetServiceTicket(String gameID, String serviceID, String masterTicket) Get a service ticket.
ZoneAccessService.StatusCodeResult	RegisterNickname(String gameID, String masterTicket, String nickname) Get a nickname.
ZoneAccessService.XMLBlobResult	RegisterPassportAccount(String gameID, String signInName, String password, String secretQuestion, String secretAnswer, String country, String region, String postalCode, String birthDate) Begin Create a new passport account.
ZoneAccessService.StatusCodeResult	VerifyTicket(String strTicket, String strChallenge, String strHash, String serviceID) Verifies that a ticket is valid.

Method Detail

GetMasterAndServiceTickets

ZoneAccessService.GetMasterAndServiceTicketsResponse GetMasterAndServiceTickets(ZoneAccessService.GetMasterAndServiceTicketsRequest request)

Get A Master Ticket and Multiple Service Tickets (0-N). Results will come back in the order 'master', 'service0', ..., 'serviceN'.

Note

This method is never used by AoM.

GetConfig

ZoneAccessService.XMLBlobResult GetConfig(String gameID)

Return configuration details about a game title.

Parameters:

gameID - Either AOM or AOMX.

RegisterNickname

ZoneAccessService.StatusCodeResult RegisterNickname(String gameID,
                                                    String masterTicket,
                                                    String nickname)

Get a nickname.

Parameters:

gameID - Either AOM or AOMX.

masterTicket - The master ticket received in a previous call.

nickname - The nickname you wish to register.

GetMasterTicket

ZoneAccessService.XMLBlobResult GetMasterTicket(String gameID)

Get a master ticket.

Parameters:

gameID - Either AOM or AOMX.

Note

This service call requires the from-PP header field returned by the Passport login.

GetServiceTicket

ZoneAccessService.XMLBlobResult GetServiceTicket(String gameID,
                                                 String serviceID,
                                                 String masterTicket)

Get a service ticket.

Parameters:

gameID - Either AOM or AOMX.

serviceID - Either LegacyAuth for use with AccountService, or Stats for use with the StatsServer.

masterTicket - The master ticket received in a previous call.

VerifyTicket

ZoneAccessService.StatusCodeResult VerifyTicket(String strTicket,
                                                String strChallenge,
                                                String strHash,
                                                String serviceID)

Verifies that a ticket is valid. This is typically called to check the CD Key tickets of the other players before starting a game.

Parameters:

strTicket - The XML code of the Ticket to verify.

strChallenge - Base64 encoding of a random byte[24].

strHash - An MD5 hash calculated by the get_Signature(challenge, sessionKey) function in zoneaccessapi.dll. I don't know the exact input of the hash function, but assembly code suggests just two (base64?) strings.

serviceID - The serviceID of the Ticket to verify: Master | CDKey | LegacyAuth | Stats

ActivateProductKey

ZoneAccessService.StatusCodeResult ActivateProductKey(String gameID,
                                                      String masterTicket,
                                                      String strDigitalPid)

Register a product key.

Parameters:

gameID - Either AOM or AOMX.

masterTicket - The master ticket received in a previous call.

strDigitalPid - base64(HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft Games\Age of Mythology[ Expansion Pack]\1.0\DigitalProductID)

GetCDKeyTicket

ZoneAccessService.XMLBlobResult GetCDKeyTicket(String gameID,
                                               String serviceID,
                                               String masterTicket,
                                               String strDigitalPid)

Get a CDKey Ticket

Parameters:

gameID - Either AOM or AOMX.

serviceID - Always "CDKey"

masterTicket - The master ticket received in a previous call.

strDigitalPid - base64(HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft Games\Age of Mythology[ Expansion Pack]\1.0\DigitalProductID)

RegisterPassportAccount

ZoneAccessService.XMLBlobResult RegisterPassportAccount(String gameID,
                                                        String signInName,
                                                        String password,
                                                        String secretQuestion,
                                                        String secretAnswer,
                                                        String country,
                                                        String region,
                                                        String postalCode,
                                                        String birthDate)

Begin Create a new passport account. When you completed this form, you'll have access to a [email protected] passport account. Note however that this account is not automatically registered with ESO. You won't be able to sign in to ESO until you activate your account in the AccountService.

Parameters:

gameID - Either AOM or AOMX.

signInName - The name of the new account.

password - The new password.

secretQuestion - The secret question in case you forget your password.

secretAnswer - The answer to the secret question above.

country - Optional.

region - Optional.

postalCode - Optional.

birthDate - Optional.

Note

This functionality broke a while ago.