This API facilitates the acquisition of vouchers for OutSystems certifications and specializations.

An Integration Services module was placed on the Forge and it can be customized by each client at will.

Web Service VoucherRequest_v1

Available Methods on version 1 by expected sequence of use:

CreateClient
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.

GenerateAPIKey
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
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.

GetClientDetails
Because each API key goes to a different user, it was wise to add a way to know who is responsible for the key we have.
This action will also allow to review the fiscal details of the company and - in case the company paid in advance - show available number of certifications and specializations.

GetManageDictionary
This method has a double functionality.
If you only pas the API key, it will give you a list if certifications/specializations 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.

CreateRequest
To place an order, use your API key and send a list of which certifications you want. Ideally with name of user, 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.

GetRequests
To have a notion of what is going on with your account, you can always look at latest movements.
Based on the date you send as filter, it will return Movement Number, Date Time, what certification was both, for who (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 specializations how many where bought/spent and what is your new total in credit. If your credit gets a boost, what invoice caused it.

Server Actions

Module VoucherRequest_IS already includes a layer so you can call the web service without hassles.

WebService -> Server Action
CreateClient -> Client_Create
GenerateAPIKey > Client_GenerateAPIKey
DisableAPIKey >Client_DisableAPIKey
GetClientDetails >Client_GetDetails
GetManageDictionary > Client_ReadDictionary (view mode) or Client_EditDictionary (edit mode)
CreateRequest > Request_Create
GetRequests - Request_Get


Samples
Two samples were created.
VoucherRequest_Demo (web) is for companies. It allows you to order certifications of multiple types for individuals or in bulk.
VoucherRequestMobileDemo (mobile) is for individuals. If assumes you only need one certification at a time.
You can play around with their code to make an app more suitable for your scenario.


Tips
If you don’t plan to use some of the methods on the service (Disable/Create API Key come to mind), you can delete them and save Application Objects on that.