Use of Galileo's API will require an apiLogin, apiTransKey, providerId and transaction Id. These will be used to authenticate requests.
Each method uses this base set of parameters that handle validation of the authentication elements. The user is authenticated before the method logic is processed.
| Parameter | Required | Data Type | Pattern | Notes | Example Value |
|---|---|---|---|---|---|
| apiLogin | Yes | String | 50 characters or less | Provider's Web Service Username as provided and authenticated by Galileo for the requesting IP Address. | AbC123-9999 |
| apiTransKey | Yes | String | 15 characters or less | Web Service Password as provided and authenticated by Galileo for the requesting IP Address. | 4sb62fh6w4h7w34g |
| providerId | Yes | Integer | 10 digits or less | Galileo issued unique Provider identifier. | 9999 |
| transactionId | Yes | String | 60 characters or less | A unique system generated ID number that identifies the API transaction with Galileo Processing systems. A UUID is preferred. This must be different for each transaction. | 9845dk-39fdk3fj3-4483483478 |
| providerTransactionId | No | String | 60 characters or less | Secondary transaction identifier (generated by provider). | 47823438032233777 |
| providerTimestamp | No | DateTime | 19 characters Format: YYYY-MM-DD HH:MM:SS | API consumers should use this parameter if they wish to store the related timestamp in their system for reporting and troubleshooting purposes. | 2017-05-01 13:01:01 |
| agentId | Conditional | String | 2-30 character alphanumeric | Agent identity for use in transaction reporting and tracking. | 43493-ABDS-3333 |
| agentFirstName | Conditional | String | 2-30 character alphanumeric string | Agent first name for use in transaction reporting and tracking. | Ed |
| agentLastName | Conditional | String | 2-30 character alphanumeric string | Agent last name for use in transaction reporting and tracking. | Harley |