Skip to content

Commit 98d03ae

Browse files
committed
Update README.md
1 parent 4bff889 commit 98d03ae

File tree

1 file changed

+17
-22
lines changed

1 file changed

+17
-22
lines changed

README.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -47,46 +47,41 @@ Execute `pytest` to run the tests.
4747

4848
## Getting Started
4949

50+
1. Find and note your company AndDone Developer settings
51+
1. Login to (UAT) https://portal.uat.anddone.com/ (Production) https://portal.anddone.com/
52+
2. In the left menu, click "Developer" then "API Keys"
53+
3. Your xApiKey will be the API Key
54+
4. Your xAppKey will be the App Key
55+
2. Find your Origin by opening a browser and browse to: https://www.whatsmyip.org/ Your origin will be your IP Address
56+
3. Create a settings file to contain AndDone specific settings
57+
1. Rename config.example.json to config.json
58+
2. Input your API key, App key, and origin into the appropriate key values of config.json
59+
5060
Please follow the [installation procedure](#installation--usage) and then run the following:
5161

5262
```python
5363

5464
import openapi_client
5565
from openapi_client.rest import ApiException
5666
from pprint import pprint
67+
import json
5768

5869
# Defining the host is optional and defaults to https://api.uat.anddone.com
5970
# See configuration.py for a list of all supported configuration parameters.
6071
configuration = openapi_client.Configuration(
6172
host = "https://api.uat.anddone.com"
6273
)
6374

64-
# The client must configure the authentication and authorization parameters
65-
# in accordance with the API server security policy.
66-
# Examples for each auth method are provided below, use the example that
67-
# satisfies your auth use case.
68-
69-
# Configure API key authorization: x-api-key
70-
configuration.api_key['x-api-key'] = os.environ["API_KEY"]
71-
72-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
73-
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
74-
75-
# Configure API key authorization: x-app-key
76-
configuration.api_key['x-app-key'] = os.environ["API_KEY"]
77-
78-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
79-
# configuration.api_key_prefix['x-app-key'] = 'Bearer'
80-
81-
8275
# Enter a context with an instance of the API client
8376
with openapi_client.ApiClient(configuration) as api_client:
8477
# Create an instance of the API class
8578
api_instance = openapi_client.SecureEmbeddedPremiumFinanceApi(api_client)
86-
x_api_key = 'x_api_key_example' # str | an authorization header
87-
x_app_key = 'x_app_key_example' # str | an authorization header
88-
x_version = 'x_version_example' # str | x-version
89-
origin = 'origin_example' # str | origin
79+
with open('config.json') as f:
80+
config = json.load(f)
81+
x_api_key = config['xApiKey']
82+
x_app_key = config['xAppKey']
83+
x_version = config['xVersion']
84+
origin = config['origin']
9085
pf_policy_update_request_dto = openapi_client.PFPolicyUpdateRequestDTO() # PFPolicyUpdateRequestDTO | Signature Request details (optional)
9186

9287
try:

0 commit comments

Comments
 (0)