Key Notes:
- An Application Programming Interface (API) Key allows a user to send TFNRegistry™ API requests using a Client Key and Secret that expires once a year no password required.
- When the user accesses the TFNRegistry UI, the 90-password change rule still applies. The user will need to access the TFNRegistry to setup and change the once yearly API key.
- Requesting the ability to manage an API Key(s) in the UI is free, no charge.
- Each API Key is assigned to one Login ID.
- Important Resp Org API Key Documents in order of usage:
- For more information on managing their API Key via the URC page (this is where they can get their API ClientKey, ClientSecret, creation date, etc. after they set up MFA), Resp Orgs will need to refer to the TFNRegistry User Guide (available within the Somos Support Center).
- Please Note: TFNRegistry users can use a single Login ID with the API Key to request multiple OAUTH tokens to allow each OAUTH token to work as an individual Login ID.
Work / Technical Steps:
A. Requirements
-
An authorized user (Primary Contact, Company Admin, or Special Approver with permissions) will submit a Special Request with the following information.
- A statement that a user(s) would like the ability to manage their API Key in the TFNRegistry UI.
- Login ID(s) that will be using the API Key (Important: Please be sure to verify the Login ID exists in the environment(s) requested.)
- Environments – Please Note: Production and Sandbox TFNRegistry will have different API Keys.
- The name of the submitter should match the requestor's name on the request.
-
When the request arrives, the checker will review the request to confirm all information is included. Important: Verify the Login ID exists in the environment(s) requested.
- If information is missing, reject the request and work with the Resp Org to resubmit it with all the information (see section C. Ticket Submission (if it was rejected)).
- If all information is provided, the checker can forward a copy of the Special Request in the Online Requests queue to themselves or to help@somos.com by using the Forward Form To feature, receive the request, PDF it and then proceed to the following section, B. Service Request Submission.
B. Service Request Submission
- The checker will create a Service Request using the following macro and macro guidelines at the end of this section and add/update the necessary information (please reference the Ticketing_Service Requests process for the specific steps).
- *Please Note: To stay on the Service Request, before selecting Submit as Open button change the Close tab option to Stay on ticket Once this setting is set you don't have to change it for each Service Request.
- Copy and Paste the ticket number in the “HD Ticket #” field, receive the request in in the Online Requests queue and add it to the Notes bubble.
-
After the ticket has been created, the checker will also complete the following steps:
- In the requested environment(s) provided on the Special Request, retrieve the Login ID provided or the Login IDs in the attached list (one at a time and in each desired environment) on the User Profile (SUD) page in the Admin TFNRegistry UI.
- When the SUD page for the desired Login ID is displayed, place a check mark to the left of the "API Key" option in the "Organizational Details" section and then select the "Submit" button to save the changes. This step will need to be repeated for all Login IDs provided in the Special Request.
- If the Login ID has the API Key option selected already, reject the request (see section C. Ticket Submission (if it was rejected)) and let the submitter know. They may just need help setting up the MFA on the URC page. If they provided more than one Login ID in the Special Request, just let the submitter know which Login ID(s) already had the permissions enabled and notate in the ticket which Login ID(s) you added the API Key option to or did not.
-
Once the SUD page in the TFNRegistry UI has been updated, the ticket and request can be resolved.
- To Resolve: Assign the ticket to yourself by selecting the take it link to the right of the Select assignee field name, select the Submit as Open button, add an Internal note, update the Actual Completion Date field with the real completion date and then selecting the Submit as Solved.
Service Request Macro - HD Resolved:
|
Ticketing System |
Zendesk |
|
Macro Name |
SR - Special Request - API Key Request - HD Resolved |
|
Assigned Group |
Somos Sykes Help Desk |
|
Priority |
Low |
|
Subject (Update text) |
SR - Special Request - API Key Request |
|
Internal note (Update text) |
Environment:[Production or Sandbox] Request Name: Special Request <Paste Request from the Website here and Attach.> Please remember to attach a PDF of the request received, complete the Requester & TFN Registry Userid/Full Name fields and update the Task Type field as needed. |
C. Ticket Submission (if request was rejected)
- After the checker has decided that the Special Request is a reject, they can create an Service Request ticket using the following macro and add/update the necessary information for our tracking purposes (please reference the Ticketing_Service Requests process for the specific steps).
- *Please Note: To stay on the Incident Request, before selecting Submit as Open button change the Close tab option to Stay on ticket Once this setting is set you don't have to change it for each ticket.
- Copy and Paste the ticket number in the “HD Ticket #” field, follow the normal rejection steps for the Special Request in the Online Requests queue and complete the request.
Service Request Macro - HD Resolved:
|
Ticketing System |
Zendesk |
|
Macro Name |
SR - Somos Portal Website - Special Request - Reject - HD Resolved |
|
Assigned Group |
Somos Sykes Help Desk |
|
Priority |
Low |
|
Subject |
SR - Somos Portal Website - Special Request - Reject |
|
Internal Note (Update text) |
Environment: Production Request Name: Special Request <Reject Reason and Notes> <Paste Request from the Website here and Attach.> <If this request has been rejected by Somos, please also attach the rejection email.> |