CreateClient
Input: structure NewClient
Output: structure Response
Before you can make any request, you need to create an account.
This will ask for your Fiscal details (Fiscal Name, VAT Number, Address and Zip code) and for your contacts (Name of Person of Contact and Email).
If you are an individual, you will be a single person of contact. But if you are a company with multiple teams, you may want different people to get the email informing that person x booked a certification.
Note: This is just for email purposes. If you need to manage different formation budgets, you need to create different accounts for the same company. In v2 there is a way to see aggregated info.
CheckClient
Input: GUID
Output: Text
While you're waiting for the confirmation email with the API, you can use this temporary GUID to check if the account creation request has been approved.
If so, you can go to the registered inbox owner and ask for the API Key.
Possible responses: Requested, Approved, Rejected, Suspended.
This GUID is useless for all other types of requests and gives no details on the users except if the account is active or not.
GenerateAPIKey
Input: ExistingAPIKey, Name, Email
Output: Response
Like explained regarding account creation, API keys can be used to differentiate contact people.
If you have one valid API key, you can request more API keys for the same account.
Just use your existing key and provide a name and email for the new person. Then you will have one more key.
Again, ALL KEYS WILL SEE THE SAME INFORMATION. Only emails will get different summaries. When you use the original key, the first person will get the emails. When you use the new one, the second person will get the emails.
For now, there is no limit on the number of keys by account. You can create one by team if it makes sense.
DisableAPIKey
Input: APIKey
With the multitude of keys created, sometimes you have just too many. With this method you can deactivate one of them.
Just make a call using that API Key and it will be unusable.
GetManageDictionary
Input: APIKey, CustomerId, SellerId
This method has a double functionality.
If you only send the API key, it will give you a list if certifications/specialisations with ID, Name, a Boolean saying if is Certification (True) or Specialization (False), the price you will pay for it, in what currency, and if it includes VAT or not (as some companies would rather see prices with no VAT).
Now imagine you have your own certification management system. You have your employees on database and the certifications. You want to keep using those. If you pass the CustomerId (your internal id) and SellerId (our internal id) for one certification, our system will be able to translate your future orders.
Note 1: Before you set them, the CustomerId will be the same as the SellerId for all certifications so you can use both and the effect will be the same. But the system will always try to translate it from CustomerId to SellerId so always use the attribute CustomerId. SellerId is only to be used when setting the mapping.
Note 2: The match must be one to one. You can’t have two codes for Mobile Specialization 11 and ODC, because they are one single exam.
Note 3: if you want to limit the list to specific certifications, It will be available in v2.1. For now, it can be done on our side. For example, we can remove all Traditional exams from the list.
CreateRequest
Input: APIKey, structure Request List
To place an order, use your API key and send a list of which certifications you want. Ideally with name of user, community email address, and Quantity=1 so we can forward the code directly to them.
Companies may want to buy in bulk and instead request multiple vouchers so you can send the name and email empty and a quantity of more than 1. In that case, unspecified people will be able to use them.
Response will return a GUID to identify the request.
NOTE: In case of no valid community email address, the codes will be sent to the email address on the API Key.
GetRequests
Input: APIKey, SinceDate, RequestId
Output: Response and Success
To have a notion of what is going on with your account, you can always look at the latest movements.
It will return Movement Number, Date Time, what certification was requested, to whom (if available), in what status it is (if can be payment pending, waiting for OS, waiting for me, sent to the user, or even have the final result the person got). For companies,
it will also say for both certifications and specialisations how many were bought/spent and what is your new total in credit. If your credit gets a boost, what invoice caused it.
One new detail is that it will show the certification that was ordered and the one that was in fact made at Prometric.
The other new is that each request has a unique GUID that you can use as input to see only that one.