API Users: How to request and use them

Prerequisites to create an API User

In order to create an API User, the Foundry Pool team will need the following:

1. A Request: An email requesting a new API user should be sent to support@foundryusapool.com with the following information:

   1. An email address that is not already in use. If you wish to reuse an email that is already in taken, plus addressing  is a valid alternative (Plus Addressing in Exchange Online). For example, If john.doe@example.com is in use, you can use john.doe+api@example.com instead.

   2. Full name and Preferred name. These can be the same value.

   3. The API User role in the pool: Owner, Technician or Accountant.

   4. List of IP’s to whitelist: Only mandatory if the role of the API User is owner.

   5. Company name under which the API User will be created.

2. Group owner’s written approval: This is unrelated to the approval-request flow inside Foundry Pool. You need to provide explicit written consent from an owner of the group.

API User: First Steps

After receiving the confirmation that the API User has been created, it will be ready for activation.

Activation of an API User

Upon creation, the API User will receive a new email from support@foundryusapool.com  to its address with the subject Verify your email requesting to confirm the user account. Click on Confirm my account.

Set up a Password for the API User

API Users need a password to be able to obtain an Access Token that will be used to interact with the endpoints of Foundry Pool’s REST API. In order to create a password for an API User the following is needed to:

1. Navigate to Foundry USA Pool

2. Click on LOG IN WITH FOUNDRY USA POOL ACCOUNT:

3. If the CAPTCHA screen doesn’t appear skip to step 4, else enter the API User email, solve the CAPTCHA and click Continue.

4. Click on Forgot password?

5. Enter the API User email in the email field and click Continue

6. The API User email will receive a new email from support@foundryusapool.com with the subject Reset your password, click on click here.

   

7. This will redirect you to Foundry Pool login website and will be prompted to enter and confirm password. Once the fields are filled, you should click on Reset password

How to use an API User

API Users can interact with the Pool’s REST API endpoints by simply passing an Access Token as the value for the Authorization header.